gambas-source-code/main/gbx/gbx_stream.c

/***************************************************************************

	stream.c

	The stream management routines

	(c) 2000-2007 Benoit Minisini <gambas@users.sourceforge.net>

	This program is free software; you can redistribute it and/or modify
	it under the terms of the GNU General Public License as published by
	the Free Software Foundation; either version 1, or (at your option)
	any later version.

	This program is distributed in the hope that it will be useful,
	but WITHOUT ANY WARRANTY; without even the implied warranty of
	MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
	GNU General Public License for more details.

	You should have received a copy of the GNU General Public License
	along with this program; if not, write to the Free Software
	Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.

***************************************************************************/

#define __GBX_STREAM_C

#include "gb_common.h"

#include <fcntl.h>
#include <stdio.h>
#include <unistd.h>
#include <sys/mman.h>
#include <sys/stat.h>
#include <sys/types.h>
#include <dirent.h>
#include <errno.h>
#include <sys/ioctl.h>

#include "gb_common_buffer.h"
#include "gb_common_swap.h"
#include "gb_common_check.h"
#include "gb_error.h"
#include "gbx_value.h"
#include "gb_limit.h"
#include "gbx_exec.h"
#include "gbx_project.h"
#include "gb_file.h"
#include "gambas.h"
#include "gbx_regexp.h"
#include "gbx_api.h"
#include "gbx_string.h"

#include "gbx_stream.h"

int STREAM_eff_read;

bool STREAM_in_archive(const char *path)
{
	ARCHIVE *arch;

	if (FILE_is_relative(path))
	{
		ARCHIVE_get_current(&arch);
		if (arch->name || EXEC_arch) // || !FILE_exist_real(path)) - Why that test ?
			return TRUE;
	}

	return FALSE;
}

static int STREAM_get_readable(STREAM *stream, int *len)
{
	int fd;
	int ret;
	off_t off;
	off_t end;

	fd = STREAM_handle(stream);
	
//_IOCTL:

	#ifdef FIONREAD

	if (!stream->common.no_fionread)
	{
		ret = ioctl(fd, FIONREAD, len);
		if (ret >= 0)
			return 0;
		
		stream->common.no_fionread = TRUE;
	}
	
	#endif

//_LSEEK:

	if (!stream->common.no_lseek)
	{
		off = lseek(fd, 0, SEEK_CUR);
		if (off >= 0)
		{
			end = lseek(fd, 0, SEEK_END);
			if (end >= 0)
			{
				*len = (int)(end - off);
	
				off = lseek(fd, off, SEEK_SET);
				if (off >= 0)
					return 0;
			}
		}
		
		stream->common.no_lseek = TRUE;
	}

	//fprintf(stderr, "STREAM_get_readable: lseek: %d\n", *len);
	return (-1);
}

static int default_eof(STREAM *stream)
{
	int fd;
	int ilen;

	fd = STREAM_handle(stream);
	if (fd < 0 || STREAM_get_readable(stream, &ilen))
		return TRUE;

	return (ilen == 0);
}

void STREAM_open(STREAM *stream, const char *path, int mode)
{
	if (FILE_is_relative(path))
	{
		ARCHIVE *arch;

		ARCHIVE_get_current(&arch);
		if (arch->name || EXEC_arch) // || !FILE_exist_real(path)) - Why that test ?
		{
			stream->type = &STREAM_arch;
			goto _OPEN;
		}

		if ((mode & ST_ACCESS) != ST_READ || mode & ST_PIPE)
			THROW(E_ACCESS);
	}

	if (mode & ST_PIPE)
	{
		stream->type = &STREAM_pipe;
	}
	else
	{
		if (mode & ST_DIRECT)
			stream->type = &STREAM_direct;
		else
			stream->type = &STREAM_buffer;
	}

_OPEN:

	stream->common.mode = mode;
	stream->common.swap = FALSE;
	stream->common.eol = 0;
	stream->common.buffer = NULL;
	stream->common.buffer_pos = 0;
	stream->common.buffer_len = 0;
	stream->common.no_fionread = FALSE;
	stream->common.no_lseek = FALSE;

	if ((*(stream->type->open))(stream, path, mode, NULL))
	{
		stream->type = NULL;
		THROW_SYSTEM(errno, path);
	}

	stream->common.is_term = isatty(STREAM_handle(stream));
}


void STREAM_release(STREAM *stream)
{
	if (stream->common.buffer)
	{
		FREE(&stream->common.buffer, "STREAM_close");
		stream->common.buffer_pos = 0;
		stream->common.buffer_len = 0;
	}
}

void STREAM_close(STREAM *stream)
{
	int fd;

	if (!stream->type)
		return;

	fd = STREAM_handle(stream);
	if (fd >= 0)
		GB_Watch(fd, GB_WATCH_NONE, NULL, 0);

	if (!(*(stream->type->close))(stream))
		stream->type = NULL;
		
	STREAM_release(stream);
}


void STREAM_flush(STREAM *stream)
{
	if (!stream->type)
		THROW(E_CLOSED);
		
	(*(stream->type->flush))(stream);
}

static void read_buffer(STREAM *stream, void **addr, int *len)
{
	int l = stream->common.buffer_len - stream->common.buffer_pos;
	if (l > *len)
		l = *len;
	if (l > 0)
	{
		memcpy(*addr, stream->common.buffer + stream->common.buffer_pos, l);
		*addr = (char *)*addr + l;
		*len -= l;
		stream->common.buffer_pos += l;
	}
}

void STREAM_read(STREAM *stream, void *addr, int len)
{
	STREAM_eff_read = 0;

	if (!stream->type)
		THROW(E_CLOSED);
	
	if (stream->common.buffer)
		read_buffer(stream, &addr, &len);
	
	if ((*(stream->type->read))(stream, addr, len))
	{
		switch(errno)
		{
			case 0:
			case EAGAIN:
				THROW(E_EOF);
			case EIO:
				THROW(E_READ);
			default:
				THROW_SYSTEM(errno, NULL);
		}
	}
}

char STREAM_getchar(STREAM *stream)
{
	char c = 0;
	bool ret;
	
	if (!stream->type)
		THROW(E_CLOSED);
	
	if (stream->common.buffer && stream->common.buffer_pos < stream->common.buffer_len)
		return stream->common.buffer[stream->common.buffer_pos++];
	
	if (stream->type->getchar)
		ret = (*(stream->type->getchar))(stream, &c);
	else
		ret = (*(stream->type->read))(stream, &c, 1);
	
	if (ret) 
	{  
		switch(errno)
		{
			case 0:
			case EAGAIN:
				THROW(E_EOF);
			case EIO:
				THROW(E_READ);
			default:
				THROW_SYSTEM(errno, NULL);
		}
	}
	
	return c;
}


void STREAM_read_max(STREAM *stream, void *addr, int len)
{
	bool is_term = stream->common.is_term;
	bool err;
	STREAM_eff_read = 0;
	int flags, handle;

	if (!stream->type)
		THROW(E_CLOSED);
		
	if (stream->common.buffer)
		read_buffer(stream, &addr, &len);
	
	if (is_term)
	{
		handle = STREAM_handle(stream);
		flags = fcntl(handle, F_GETFL);
		fcntl(handle, F_SETFL, flags | O_NONBLOCK);
		
		err = (*(stream->type->read))(stream, addr, len);
		
		fcntl(handle, F_SETFL, flags);
	}
	else
	{
		err = (*(stream->type->read))(stream, addr, len);
	}
	

	if (err)
	{
		switch(errno)
		{
			case 0:
			case EAGAIN:
				break;
			case EIO:
				break; //THROW(E_READ);
			default:
				THROW_SYSTEM(errno, NULL);
		}
	}
}


void STREAM_write(STREAM *stream, void *addr, int len)
{
	if (!stream->type)
		THROW(E_CLOSED);
		
	if ((*(stream->type->write))(stream, addr, len))
	{
		switch(errno)
		{
			case EIO:
				THROW(E_WRITE);
			default:
				THROW_SYSTEM(errno, NULL);
		}
	}
}

void STREAM_write_eol(STREAM *stream)
{
	if (!stream->type)
		THROW(E_CLOSED);
		
	switch(stream->common.eol)
	{
		case ST_EOL_UNIX: STREAM_write(stream, "\n", 1); break;
		case ST_EOL_WINDOWS: STREAM_write(stream, "\r\n", 2); break;
		case ST_EOL_MAC: STREAM_write(stream, "\r", 1); break;
	}
}


int64_t STREAM_tell(STREAM *stream)
{
	int64_t pos;

	if (!stream->type)
		THROW(E_CLOSED);
		
	if (stream->type->tell(stream, &pos))
		/*THROW(E_SEEK, ERROR_get());*/
		THROW_SYSTEM(errno, NULL);

	return pos;
}


void STREAM_seek(STREAM *stream, int64_t pos, int whence)
{
	if (!stream->type)
		THROW(E_CLOSED);
		
	if (stream->type->seek(stream, pos, whence))
	{
		switch(errno)
		{
			case EINVAL:
				THROW(E_ARG);
			default:
				THROW_SYSTEM(errno, NULL);
		}
	}
}


static void input(STREAM *stream, char **addr, boolean line)
{
	int len = 0;
	int start;
	unsigned char c, lc = 0;
	void *test;
	bool eol;
	char *buffer;
	short buffer_len;
	short buffer_pos;
	
	*addr = NULL;

	stream->common.eof = FALSE;
	
	if (!line)
		test = &&__TEST_INPUT;
	else
	{
		switch(stream->common.eol)
		{
			case 1: test = &&__TEST_WINDOWS; break;
			case 2: test = &&__TEST_MAC; break;
			default: test = &&__TEST_UNIX; break;
		}
	}

	if (STREAM_eof(stream))
		THROW(E_EOF);
		
	buffer = stream->common.buffer;
	buffer_len = stream->common.buffer_len;
	buffer_pos = stream->common.buffer_pos;
		
	if (!buffer)
	{
		ALLOC(&buffer, STREAM_BUFFER_SIZE, "input");
		buffer_pos = 0;
		buffer_len = 0;
	}

	/*eof_func = stream->type->eof;
	if (!eof_func)
		eof_func = default_eof;*/

	start = buffer_pos;
	
	for(;;)
	{
		if (buffer_pos == buffer_len)
		{
			if (len)
			{
				//add_string(addr, &len_str, stream->common.buffer + start, len);
				STRING_add(addr, buffer + start, len);
				len = 0;
			}
			
			stream->common.buffer = buffer;
			stream->common.buffer_pos = buffer_pos;
			stream->common.buffer_len = buffer_len;
			
			STREAM_read_max(stream, buffer, STREAM_BUFFER_SIZE);
			
			buffer_pos = 0;
			buffer_len = STREAM_eff_read;
			
			if (!buffer_len)
			{
				stream->common.eof = TRUE;
				break;
			}
			
			start = 0;
		}
		
		c = buffer[buffer_pos++]; //STREAM_getchar(stream);

		goto *test;

	__TEST_INPUT:

		eol = (c <= ' ');
		goto __TEST_OK;

	__TEST_UNIX:

		eol = (c == '\n');
		if (lc == '\r')
			len--;
		lc = c;
		goto __TEST_OK;

	__TEST_MAC:

		eol = (c == '\r');
		goto __TEST_OK;

	__TEST_WINDOWS:

		eol = (lc == '\r') && (c == '\n');
		if (eol)
			len--;
		lc = c;
		goto __TEST_OK;

	__TEST_OK:

		if (eol)
			break;

		len++;
		//COMMON_buffer[len++] = c;

		// Optimized eof
		
		/*
		if (STREAM_eof(stream))
		{
			stream->common.eof = TRUE;
			break;
		}
		*/
		/*if ((*eof_func)(stream))
		{
			stream->common.eof = TRUE;
			break;
		}*/
	}

	if (len > 0)
		//add_string(addr, &len_str, stream->common.buffer + start, len);
		STRING_add(addr, buffer + start, len);

	STRING_extend_end(addr);
	
	stream->common.buffer = buffer;
	stream->common.buffer_pos = buffer_pos;
	stream->common.buffer_len = buffer_len;
}


void STREAM_line_input(STREAM *stream, char **addr)
{
	input(stream, addr, TRUE);
}


void STREAM_input(STREAM *stream, char **addr)
{
	input(stream, addr, FALSE);
}


void STREAM_read_type(STREAM *stream, TYPE type, VALUE *value, int len)
{
	unsigned char data[4];

	if (type == T_VARIANT)
	{
		STREAM_read(stream, data, 1);
		type = *data;		
	}
	
	value->type = type;

	switch (type)
	{
		case T_BOOLEAN:

			STREAM_read(stream, data, 1);
			value->_integer.value = (*data != 0) ? (-1) : 0;
			break;

		case T_BYTE:

			STREAM_read(stream, data, 1);
			value->_integer.value = *data;
			break;

		case T_SHORT:

			STREAM_read(stream, data, sizeof(short));
			if (stream->common.swap)
				SWAP_short((short *)data);
			value->_integer.value = (int)*((short *)data);
			break;

		case T_INTEGER:

			STREAM_read(stream, &value->_integer.value, sizeof(int));
			if (stream->common.swap)
				SWAP_int(&value->_integer.value);
			break;

		case T_LONG:

			STREAM_read(stream, &value->_long.value, sizeof(int64_t));
			if (stream->common.swap)
				SWAP_double((double *)(void *)&value->_long.value);
			break;

		case T_SINGLE:

			STREAM_read(stream, data, sizeof(float));
			if (stream->common.swap)
				SWAP_int((int *)data);
			value->_float.value = (double)*((float *)data);
			break;

		case T_FLOAT:

			STREAM_read(stream, &value->_float.value, sizeof(double));
			if (stream->common.swap)
				SWAP_double(&value->_float.value);
			break;

		case T_DATE:

			STREAM_read(stream, &value->_date.date, sizeof(int));
			STREAM_read(stream, &value->_date.time, sizeof(int));
			if (stream->common.swap)
			{
				SWAP_int(&value->_date.date);
				SWAP_int(&value->_date.time);
			}
			break;

		case T_CSTRING:
			value->type = T_STRING;
			// continue
		
		case T_STRING:

			if (len == 0)
			{
				if (stream->type == &STREAM_memory)
				{
					size_t slen;
					if (CHECK_strlen(stream->memory.addr + stream->memory.pos, &slen))
						THROW(E_READ);
					len = (int)slen;
				}
				else
				{
					STREAM_read(stream, data, 1);

					switch (*data >> 6)
					{
						case 0:
						case 1:
							len = *data;
							break;

						case 2:
							STREAM_read(stream, &data[1], 1);
							*data &= 0x3F;

							if (!EXEC_big_endian)
								SWAP_short((short *)data);

							len = *((short *)data);
							break;

						case 3:
							STREAM_read(stream, &data[1], 3);
							*data &= 0x3F;

							if (!EXEC_big_endian)
								SWAP_int((int *)data);

							len = *((int *)data);
							break;
					}
				}
			}

			if (len > 0)
			{
				STRING_new_temp_value(value, NULL, labs(len));
				STREAM_read(stream, value->_string.addr, len);
			}
			else
			{
				len = (-len);
				
				value->type = T_STRING;
				STRING_new(&value->_string.addr, NULL, len);
				value->_string.start = 0;
				value->_string.len = len;
				
				STREAM_read_max(stream, value->_string.addr, len);
				
				if (STREAM_eff_read == 0)
				{
					value->type = T_NULL;
					STRING_free(&value->_string.addr);
				}
				else
				{
					if (STREAM_eff_read < len)
					{
						STRING_extend(&value->_string.addr, STREAM_eff_read);
						value->_string.len = STREAM_eff_read;
					}
					STRING_extend_end(&value->_string.addr);
				}
			}

			break;

		default:

			THROW(E_TYPE, "Standard type", TYPE_get_name(type));
	}
}


void STREAM_write_type(STREAM *stream, TYPE type, VALUE *value, int len)
{
	unsigned char data[8];
	bool write_zero;

	if (type == T_VARIANT)
	{
		VARIANT_undo(value);
		type = value->type;
		*data = (unsigned char)type;
		STREAM_write(stream, data, 1);
	}

	//value->type = type;

	switch (type)
	{
		case T_BOOLEAN:

			*data = value->_integer.value ? 0xFF : 0;
			STREAM_write(stream, data, 1);
			break;

		case T_BYTE:

			*data = (unsigned char)value->_integer.value;
			STREAM_write(stream, data, 1);
			break;

		case T_SHORT:

			*((short *)data) = (short)value->_integer.value;
			if (stream->common.swap)
				SWAP_short((short *)data);
			STREAM_write(stream, data, sizeof(short));
			break;

		case T_INTEGER:

			*((int *)data) = value->_integer.value;
			if (stream->common.swap)
				SWAP_int((int *)data);
			STREAM_write(stream, data, sizeof(int));
			break;

		case T_LONG:

			*((int64_t *)data) = value->_long.value;
			if (stream->common.swap)
				SWAP_double((double *)data);
			STREAM_write(stream, data, sizeof(int64_t));
			break;

		case T_SINGLE:

			*((float *)data) = (float)value->_float.value;
			if (stream->common.swap)
				SWAP_int((int *)data);
			STREAM_write(stream, data, sizeof(float));
			break;

		case T_FLOAT:

			*((double *)data) = value->_float.value;
			if (stream->common.swap)
				SWAP_double((double *)data);
			STREAM_write(stream, data, sizeof(double));
			break;

		case T_DATE:

			*((int *)data) = value->_date.date;
			if (stream->common.swap)
				SWAP_int((int *)data);
			STREAM_write(stream, data, sizeof(int));

			*((int *)data) = value->_date.time;
			if (stream->common.swap)
				SWAP_int((int *)data);
			STREAM_write(stream, data, sizeof(int));

			break;

		case T_STRING:
		case T_CSTRING:

			write_zero = (stream->type == &STREAM_memory) && len == 0;

			if (len == 0)
			{
				len = value->_string.len;

				if (stream->type != &STREAM_memory)
				{
					if (len < 0x80)
					{
						*data = (unsigned char)len;
						STREAM_write(stream, data, 1);
					}
					else if (len < 0x4000)
					{
						*((short *)data) = (short)len | 0x8000;
						if (!EXEC_big_endian)
							SWAP_short((short *)data);
						STREAM_write(stream, data, 2);
					}
					else
					{
						*((int *)data) = len | 0xC0000000;
						if (!EXEC_big_endian)
							SWAP_int((int *)data);
						STREAM_write(stream, data, 4);
					}
				}
			}

			STREAM_write(stream, value->_string.addr + value->_string.start, Min(len, value->_string.len));

			*data = 0;

			while (len > value->_string.len)
			{
				STREAM_write(stream, data, 1);
				len--;
			}

			if (write_zero)
				STREAM_write(stream, data, 1);

			break;
			
		case T_NULL:
		
			*data = 0;
			STREAM_write(stream, data, 1);
			break;

		/*case T_OBJECT:
		
			class = OBJECT_class(value->_object.object);
			if (class == CLASS_Array || CLASS_inherits(class, CLASS_Array))
			{
				CARRAY_stream_write((CARRAY *)value->_object.object, stream);
				break;
			}
			else if (class == CLASS_Collection || CLASS_inherits(class, CLASS_Collection))
			{
				CCOLLECTION_stream_write((CCOLLECTION *)value->_object.object, stream);
				break;
			}*/			 

		default:

			THROW(E_TYPE, "Standard type", TYPE_get_name(type));
	}
}


void STREAM_load(const char *path, char **buffer, int *rlen)
{
	STREAM stream;
	int64_t len;

	STREAM_open(&stream, path, ST_READ);
	STREAM_lof(&stream, &len);

	if (len >> 31)
		THROW(E_MEMORY);

	*rlen = len;

	ALLOC(buffer, *rlen, "STREAM_load");

	STREAM_read(&stream, *buffer, *rlen);
	STREAM_close(&stream);
}


bool STREAM_map(const char *path, char **buffer, int *rlen)
{
	STREAM stream;

	STREAM_open(&stream, path, ST_READ);
	if (stream.type != &STREAM_arch)
	{
		STREAM_close(&stream);
		STREAM_load(path, buffer, rlen);
		return TRUE;
	}

	//fprintf(stderr, "use mmap: %s\n", path);

	*buffer = (char *)stream.arch.arch->arch->addr + stream.arch.start;
	*rlen = stream.arch.size;
	return FALSE;
}


int STREAM_handle(STREAM *stream)
{
	if (!stream->type)
		THROW(E_CLOSED);
		
	if (stream->type->handle)
		return (*stream->type->handle)(stream);
	else
		return (-1);
}


void STREAM_lock(STREAM *stream)
{
	int64_t pos;
	int fd;

	if (!stream->type)
		THROW(E_CLOSED);
		
	fd = STREAM_handle(stream);
	if (fd < 0)
		THROW(E_LOCK);

	pos = lseek(fd, 0, SEEK_CUR);
	if (pos < 0)
		goto __ERROR;

	if (lseek(fd, 0, SEEK_SET) < 0)
		goto __ERROR;

	#ifdef F_TLOCK

		if (lockf(fd, F_TLOCK, 0))
		{
			if (errno == EAGAIN)
				THROW(E_LOCK);
			else
				goto __ERROR;
		}
		
	#else
	
		fprintf(stderr, "locking is not implemented\n");
	
	#endif

	if (lseek(fd, pos, SEEK_SET) < 0)
		goto __ERROR;

	return;

__ERROR:
	THROW_SYSTEM(errno, NULL);
}



void STREAM_lof(STREAM *stream, int64_t *len)
{
	int fd;
	int ilen;

	if (!stream->type)
		THROW(E_CLOSED);
		
	if (stream->type->lof)
	{
		if (!(*(stream->type->lof))(stream, len))
			return;
	}

	fd = STREAM_handle(stream);
	if ((fd >= 0) && (STREAM_get_readable(stream, &ilen) == 0))
		*len = ilen;
		
	if (stream->common.buffer)
		*len += stream->common.buffer_len - stream->common.buffer_pos;
}

bool STREAM_eof(STREAM *stream)
{
	if (!stream->type)
		THROW(E_CLOSED);
		
	if (stream->common.buffer && stream->common.buffer_pos < stream->common.buffer_len)
		return FALSE;

	if (stream->type->eof)
		return ((*(stream->type->eof))(stream));
	else
		return default_eof(stream);
}


int STREAM_read_direct(int fd, char *buffer, int len)
{
	ssize_t eff_read;
	ssize_t len_read;

	while (len > 0)
	{
		len_read = Min(len, MAX_IO);
		eff_read = read(fd, buffer, len_read);

		if (eff_read > 0)
		{
			STREAM_eff_read += eff_read;
			len -= eff_read;
			buffer += eff_read;
		}

		if (eff_read < len_read)
		{
			if (eff_read == 0)
				errno = 0;
			if (eff_read <= 0 && errno != EINTR)
				return TRUE;
		}

	}

	return FALSE;
}

int STREAM_write_direct(int fd, char *buffer, int len)
{
	ssize_t eff_write;
	ssize_t len_write;

	while (len > 0)
	{
		len_write = Min(len, MAX_IO);
		eff_write = write(fd, buffer, len_write);

		if (eff_write < len_write)
		{
			if (eff_write <= 0 && errno != EINTR)
				return TRUE;
		}

		len -= eff_write;
		buffer += eff_write;
	}

	return FALSE;
}