dvander@2726: /**
dvander@2726:  * vim: set ts=4 :
dvander@2726:  * =============================================================================
dvander@2726:  * SourceMod
dvander@2726:  * Copyright (C) 2004-2008 AlliedModders LLC.  All rights reserved.
dvander@2726:  * =============================================================================
dvander@2726:  *
dvander@2726:  * This program is free software; you can redistribute it and/or modify it under
dvander@2726:  * the terms of the GNU General Public License, version 3.0, as published by the
dvander@2726:  * Free Software Foundation.
dvander@2726:  * 
dvander@2726:  * This program is distributed in the hope that it will be useful, but WITHOUT
dvander@2726:  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
dvander@2726:  * FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
dvander@2726:  * details.
dvander@2726:  *
dvander@2726:  * You should have received a copy of the GNU General Public License along with
dvander@2726:  * this program.  If not, see <http://www.gnu.org/licenses/>.
dvander@2726:  *
dvander@2726:  * As a special exception, AlliedModders LLC gives you permission to link the
dvander@2726:  * code of this program (as well as its derivative works) to "Half-Life 2," the
dvander@2726:  * "Source Engine," the "SourcePawn JIT," and any Game MODs that run on software
dvander@2726:  * by the Valve Corporation.  You must obey the GNU General Public License in
dvander@2726:  * all respects for all other code used.  Additionally, AlliedModders LLC grants
dvander@2726:  * this exception to all derivative works.  AlliedModders LLC defines further
dvander@2726:  * exceptions, found in LICENSE.txt (as of this writing, version JULY-31-2007),
dvander@2726:  * or <http://www.sourcemod.net/license.php>.
dvander@2726:  *
dvander@2726:  * Version: $Id$
dvander@2726:  */
dvander@2726: 
dvander@2726: #include <stdio.h>
dvander@2726: #include <ctype.h>
dvander@2726: #include <wctype.h>
dvander@2726: #include <string.h>
dvander@2726: #include <stdlib.h>
dvander@2726: #include <assert.h>
dvander@2726: #include "TextParsers.h"
dvander@2726: #include <ILibrarySys.h>
dvander@2726: 
dvander@2726: TextParsers g_TextParser;
dvander@2726: ITextParsers *textparsers = &g_TextParser;
dvander@2726: 
dvander@2726: static int g_ini_chartable1[255] = {0};
dvander@2726: static int g_ws_chartable[255] = {0};
dvander@2726: 
dvander@2726: bool TextParsers::IsWhitespace(const char *stream)
dvander@2726: {
dvander@2726: 	return g_ws_chartable[(unsigned char)*stream] == 1;
dvander@2726: }
dvander@2726: 
dvander@2726: TextParsers::TextParsers()
dvander@2726: {
dvander@2726: 	g_ini_chartable1[(unsigned)'_'] = 1;
dvander@2726: 	g_ini_chartable1[(unsigned)'-'] = 1;
dvander@2726: 	g_ini_chartable1[(unsigned)','] = 1;
dvander@2726: 	g_ini_chartable1[(unsigned)'+'] = 1;
dvander@2726: 	g_ini_chartable1[(unsigned)'.'] = 1;
dvander@2726: 	g_ini_chartable1[(unsigned)'$'] = 1;
dvander@2726: 	g_ini_chartable1[(unsigned)'?'] = 1;
dvander@2726: 	g_ini_chartable1[(unsigned)'/'] = 1;
dvander@2726: 	g_ws_chartable[(unsigned)'\n'] = 1;
dvander@2726: 	g_ws_chartable[(unsigned)'\v'] = 1;
dvander@2726: 	g_ws_chartable[(unsigned)'\r'] = 1;
dvander@2726: 	g_ws_chartable[(unsigned)'\t'] = 1;
dvander@2726: 	g_ws_chartable[(unsigned)'\f'] = 1;
dvander@2726: 	g_ws_chartable[(unsigned)' '] = 1;
dvander@2726: }
dvander@2726: 
dvander@2726: void TextParsers::OnSourceModAllInitialized()
dvander@2726: {
dvander@2726: 	sharesys->AddInterface(NULL, this);
dvander@2726: }
dvander@2726: 
dvander@2726: unsigned int TextParsers::GetUTF8CharBytes(const char *stream)
dvander@2726: {
dvander@2726: 	return _GetUTF8CharBytes(stream);
dvander@2726: }
dvander@2726: 
dvander@2726: /**
dvander@2726:  * File streams
dvander@2726:  */
dvander@2726: 
dvander@2726: bool FileStreamReader(void *stream, char *buffer, size_t maxlength, unsigned int *read)
dvander@2726: {
dvander@2726: 	size_t num = fread(buffer, 1, maxlength, (FILE *)stream);
dvander@2726: 
dvander@2726: 	*read = static_cast<unsigned int>(num);
dvander@2726: 
dvander@2726: 	if (num == 0 && feof((FILE *)stream))
dvander@2726: 	{
dvander@2726: 		return true;
dvander@2726: 	}
dvander@2726: 
dvander@2726: 	return (ferror((FILE *)stream) == 0);
dvander@2726: }
dvander@2726: 
dvander@2726: SMCError TextParsers::ParseFile_SMC(const char *file, ITextListener_SMC *smc, SMCStates *states)
dvander@2726: {
dvander@2726: 	FILE *fp = fopen(file, "rt");
dvander@2726: 
dvander@2726: 	if (!fp)
dvander@2726: 	{
dvander@2726: 		if (states != NULL)
dvander@2726: 		{
dvander@2726: 			states->line = 0;
dvander@2726: 			states->col = 0;
dvander@2726: 		}
dvander@2726: 		return SMCError_StreamOpen;
dvander@2726: 	}
dvander@2726: 
dvander@2726: 	SMCError result = ParseStream_SMC(fp, FileStreamReader, smc, states);
dvander@2726: 
dvander@2726: 	fclose(fp);
dvander@2726: 
dvander@2726: 	return result;
dvander@2726: }
dvander@2726: 
dvander@2726: SMCError TextParsers::ParseSMCFile(const char *file,
dvander@2726: 								   ITextListener_SMC *smc_listener,
dvander@2726: 								   SMCStates *states,
dvander@2726: 								   char *buffer,
dvander@2726: 								   size_t maxsize)
dvander@2726: {
dvander@2726: 	const char *errstr;
dvander@2726: 	FILE *fp = fopen(file, "rt");
dvander@2726: 
dvander@2726: 	if (fp == NULL)
dvander@2726: 	{
dvander@2726: 		char error[256] = "unknown";
dvander@2726: 		if (states != NULL)
dvander@2726: 		{
dvander@2726: 			states->line = 0;
dvander@2726: 			states->col = 0;
dvander@2726: 		}
dvander@2726: 		libsys->GetPlatformError(error, sizeof(error));
dvander@2726: 		smcore.Format(buffer, maxsize, "File could not be opened: %s", error);
dvander@2726: 		return SMCError_StreamOpen;
dvander@2726: 	}
dvander@2726: 
dvander@2726: 	SMCError result = ParseStream_SMC(fp, FileStreamReader, smc_listener, states);
dvander@2726: 
dvander@2726: 	fclose(fp);
dvander@2726: 
dvander@2726: 	errstr = GetSMCErrorString(result);
dvander@2726: 	smcore.Format(buffer, maxsize, "%s", errstr != NULL ? errstr : "Unknown error");
dvander@2726: 
dvander@2726: 	return result;
dvander@2726: }
dvander@2726: 
dvander@2726: struct RawStream
dvander@2726: {
dvander@2726: 	const char *stream;
dvander@2726: 	size_t length;
dvander@2726: 	size_t pos;
dvander@2726: };
dvander@2726: 
dvander@2726: bool RawStreamReader(void *stream, char *buffer, size_t maxlength, unsigned int *read)
dvander@2726: {
dvander@2726: 	RawStream *rs = (RawStream *)stream;
dvander@2726: 
dvander@2726: 	if (rs->pos >= rs->length)
dvander@2726: 	{
dvander@2726: 		return false;
dvander@2726: 	}
dvander@2726: 
dvander@2726: 	size_t remaining = rs->length - rs->pos;
dvander@2726: 
dvander@2726: 	/* Use the smaller of the two */
dvander@2726: 	size_t copy = (remaining > maxlength) ? maxlength : remaining;
dvander@2726: 
dvander@2726: 	memcpy(buffer, &rs->stream[rs->pos], copy);
dvander@2726: 	rs->pos += copy;
dvander@2726: 	*read = copy;
dvander@2726: 	assert(rs->pos <= rs->length);
dvander@2726: 
dvander@2726: 	return true;
dvander@2726: }
dvander@2726: 
dvander@2726: SMCError TextParsers::ParseSMCStream(const char *stream,
dvander@2726: 									 size_t length,
dvander@2726: 									 ITextListener_SMC *smc_listener,
dvander@2726: 									 SMCStates *states,
dvander@2726: 									 char *buffer,
dvander@2726: 									 size_t maxsize)
dvander@2726: {
dvander@2726: 	RawStream rs;
dvander@2726: 	SMCError result;
dvander@2726: 
dvander@2726: 	rs.stream = stream;
dvander@2726: 	rs.length = length;
dvander@2726: 	rs.pos = 0;
dvander@2726: 
dvander@2726: 	result = ParseStream_SMC(&rs, RawStreamReader, smc_listener, states);
dvander@2726: 
dvander@2726: 	const char *errstr = GetSMCErrorString(result);
dvander@2726: 	smcore.Format(buffer, maxsize, "%s", errstr != NULL ? errstr : "Unknown error");
dvander@2726: 
dvander@2726: 	return result;
dvander@2726: }
dvander@2726: 
dvander@2726: /** 
dvander@2726:  * Raw parsing of streams with helper functions
dvander@2726:  */
dvander@2726: 
dvander@2726: struct StringInfo
dvander@2726: {
dvander@2726: 	StringInfo() : quoted(false), ptr(NULL), end(NULL), special(false) { }
dvander@2726: 	bool quoted;
dvander@2726: 	char *ptr;
dvander@2726: 	char *end;
dvander@2726: 	bool special;
dvander@2726: };
dvander@2726: 
dvander@2726: const char *FixupString(StringInfo &data)
dvander@2726: {
dvander@2726: 	if (!data.ptr)
dvander@2726: 	{
dvander@2726: 		return NULL;
dvander@2726: 	}
dvander@2726: 
dvander@2726: 	if (data.quoted)
dvander@2726: 	{
dvander@2726: 		data.ptr++;
dvander@2726: 	}
dvander@2726: #if defined _DEBUG
dvander@2726: 	else {
dvander@2726: 		/* A string will never have beginning whitespace because we ignore it in the stream.
dvander@2726: 		 * Furthermore, if there is trailing whitespace, the end ptr will point to it, so it is valid
dvander@2726: 		 * to overwrite!  Lastly, the last character must be whitespace or a comment/invalid character.
dvander@2726: 		 */
dvander@2726:  	}
dvander@2726: #endif
dvander@2726: 
dvander@2726: 	/* Do some extra work on strings that have special quoted characters. */
dvander@2726: 	if (data.special)
dvander@2726: 	{
dvander@2726: 		char *outptr = data.ptr;
dvander@2726: 		size_t len = data.end - data.ptr;
dvander@2726: 		if (len >= 2)
dvander@2726: 		{
dvander@2726: 			for (size_t i=0; i<len; i++)
dvander@2726: 			{
dvander@2726: 				if (data.ptr[i] == '\\' && i < len - 1)
dvander@2726: 				{
dvander@2726: 					/* Resolve the next character. */
dvander@2726: 					i++;
dvander@2726: 					if (data.ptr[i] == 'n')
dvander@2726: 					{
dvander@2726: 						data.ptr[i] = '\n';
dvander@2726: 					} else if (data.ptr[i] == 't') {
dvander@2726: 						data.ptr[i] = '\t';
dvander@2726: 					} else if (data.ptr[i] == 'r') {
dvander@2726: 						data.ptr[i] = '\r';
dvander@2726: 					} else if (data.ptr[i] != '\\'
dvander@2726: 						&& data.ptr[i] != '"') {
dvander@2726: 						/* This character is invalid, so go back one */
dvander@2726: 						i--;
dvander@2726: 					}
dvander@2726: 				}
dvander@2726: 				*outptr++ = data.ptr[i];
dvander@2726: 			}
dvander@2726: 			*outptr = '\0';
dvander@2726: 		}
dvander@2726: 	}
dvander@2726: 
dvander@2726: 	if (data.end)
dvander@2726: 	{
dvander@2726: 		*(data.end) = '\0';
dvander@2726: 	}
dvander@2726: 
dvander@2726: 	return data.ptr;
dvander@2726: }
dvander@2726: 
dvander@2726: const char *rotate(StringInfo info[3])
dvander@2726: {
dvander@2726: 	if (info[2].ptr != NULL)
dvander@2726: 	{
dvander@2726: 		return info[2].ptr;
dvander@2726: 	}
dvander@2726: 
dvander@2726: 	if (info[0].ptr != NULL)
dvander@2726: 	{
dvander@2726: 		info[2] = info[1];
dvander@2726: 		info[1] = info[0];
dvander@2726: 		info[0] = StringInfo();
dvander@2726: 	}
dvander@2726: 	
dvander@2726: 	return NULL;
dvander@2726: }
dvander@2726: 
dvander@2726: void scrap(StringInfo info[3])
dvander@2726: {
dvander@2726: 	info[2] = StringInfo();
dvander@2726: 	info[1] = StringInfo();
dvander@2726: 	info[0] = StringInfo();
dvander@2726: }
dvander@2726: 
dvander@2726: void reloc(StringInfo &data, unsigned int bytes)
dvander@2726: {
dvander@2726: 	if (data.ptr)
dvander@2726: 	{
dvander@2726: 		data.ptr -= bytes;
dvander@2726: 	}
dvander@2726: 	if (data.end)
dvander@2726: 	{
dvander@2726: 		data.end -= bytes;
dvander@2726: 	}
dvander@2726: }
dvander@2726: 
dvander@2726: char *lowstring(StringInfo info[3])
dvander@2726: {
dvander@2726: 	for (int i=2; i>=0; i--)
dvander@2726: 	{
dvander@2726: 		if (info[i].ptr)
dvander@2726: 		{
dvander@2726: 			return info[i].ptr;
dvander@2726: 		}
dvander@2726: 	}
dvander@2726: 
dvander@2726: 	return NULL;
dvander@2726: }
dvander@2726: 
dvander@2726: SMCError TextParsers::ParseStream_SMC(void *stream, 
dvander@2726: 								   STREAMREADER srdr, 
dvander@2726: 								   ITextListener_SMC *smc, 
dvander@2726: 								   SMCStates *pStates)
dvander@2726: {
dvander@2726: 	char *reparse_point = NULL;
dvander@2726: 	char in_buf[4096];
dvander@2726: 	char *parse_point = in_buf;
dvander@2726: 	char *line_begin = in_buf;
dvander@2726: 	unsigned int read;
dvander@2726: 	unsigned int curlevel = 0;
dvander@2726: 	bool in_quote = false;
dvander@2726: 	bool ignoring = false;
dvander@2726: 	bool eol_comment = false;
dvander@2726: 	bool ml_comment = false;
dvander@2726: 	unsigned int i;
dvander@2726: 	SMCError err = SMCError_Okay;
dvander@2726: 	SMCResult res;
dvander@2726: 	SMCStates states;
dvander@2726: 	char c;
dvander@2726: 
dvander@2726: 	StringInfo strings[3];
dvander@2726: 	StringInfo emptystring;
dvander@2726: 
dvander@2726: 	states.line = 1;
dvander@2726: 	states.col = 0;
dvander@2726: 
dvander@2726: 	smc->ReadSMC_ParseStart();
dvander@2726: 
dvander@2726: 	/**
dvander@2726: 	 * The stream reader reads in as much as it can fill the buffer with.
dvander@2726: 	 * It then processes the buffer.  If the buffer cannot be fully processed, for example, 
dvander@2726: 	 * a line is left hanging with no newline, then the contents of the buffer is shifted 
dvander@2726: 	 * down, and the buffer is filled from the stream reader again.
dvander@2726: 	 *
dvander@2726: 	 * What makes this particularly annoying is that we cache pointers everywhere, so when 
dvander@2726: 	 * the shifting process takes place, all those pointers must be shifted as well.
dvander@2726: 	 */
dvander@2726: 	while (srdr(stream, parse_point, sizeof(in_buf) - (parse_point - in_buf) - 1, &read))
dvander@2726: 	{
dvander@2726: 		if (!read)
dvander@2726: 		{
dvander@2726: 			break;
dvander@2726: 		}
dvander@2726: 
dvander@2726: 		/* Check for BOM markings, which is only relevant on the first line.
dvander@2726: 		 * Not worth it, but it could be moved out of the loop.
dvander@2726: 		 */
dvander@2726: 		if (states.line == 1 && 
dvander@2726: 			in_buf[0] == (char)0xEF && 
dvander@2726: 			in_buf[1] == (char)0xBB && 
dvander@2726: 			in_buf[2] == (char)0xBF)
dvander@2726: 		{
dvander@2726: 			/* Move EVERYTHING down :\ */
dvander@2726: 			memmove(in_buf, &in_buf[3], read - 3);
dvander@2726: 			read -= 3;
dvander@2726: 		}
dvander@2726: 
dvander@2726: 		if (reparse_point)
dvander@2726: 		{
dvander@2726: 			read += (parse_point - reparse_point);
dvander@2726: 			parse_point = reparse_point;
dvander@2726: 			reparse_point = NULL;
dvander@2726: 		}
dvander@2726: 
dvander@2726: 		for (i=0; i<read; i++)
dvander@2726: 		{
dvander@2726: 			c = parse_point[i];
dvander@2726: 			if (c == '\n')
dvander@2726: 			{
dvander@2726: 				/* If we got a newline, there's a lot of things that could have happened in the interim.
dvander@2726: 				 * First, let's make sure the staged strings are rotated.
dvander@2726: 				 */
dvander@2726: 				if (strings[0].ptr)
dvander@2726: 				{
dvander@2726: 					strings[0].end = &parse_point[i];
dvander@2726: 					if (rotate(strings) != NULL)
dvander@2726: 					{
dvander@2726: 						err = SMCError_InvalidTokens;
dvander@2726: 						goto failed;
dvander@2726: 					}
dvander@2726: 				}
dvander@2726: 
dvander@2726: 				/* Next, let's clear some line-based values that may no longer have meaning */
dvander@2726: 				eol_comment = false;
dvander@2726: 				in_quote = false;
dvander@2726: 				if (ignoring && !ml_comment)
dvander@2726: 				{
dvander@2726: 					ignoring = false;
dvander@2726: 				}
dvander@2726: 
dvander@2726: 				/* Pass the raw line onto the listener.  We terminate the line so the receiver 
dvander@2726: 				 * doesn't get tons of useless info.  We restore the newline after.
dvander@2726: 				 */
dvander@2726: 				parse_point[i] = '\0';
dvander@2726: 				if ((res=smc->ReadSMC_RawLine(&states, line_begin)) != SMCResult_Continue)
dvander@2726: 				{
dvander@2726: 					err = (res == SMCResult_HaltFail) ? SMCError_Custom : SMCError_Okay;
dvander@2726: 					goto failed;
dvander@2726: 				}
dvander@2726: 				parse_point[i] = '\n';
dvander@2726: 
dvander@2726: 				/* Now we check the sanity of our staged strings! */
dvander@2726: 				if (strings[2].ptr)
dvander@2726: 				{
dvander@2726: 					if (!curlevel)
dvander@2726: 					{
dvander@2726: 						err = SMCError_InvalidProperty1;
dvander@2726: 						goto failed;
dvander@2726: 					}
dvander@2726: 					/* Assume the next string is a property and pass the info on. */
dvander@2726: 					if ((res=smc->ReadSMC_KeyValue(
dvander@2726: 						&states,
dvander@2726: 						FixupString(strings[2]),
dvander@2726: 						FixupString(strings[1]))) != SMCResult_Continue)
dvander@2726: 					{
dvander@2726: 						err = (res == SMCResult_HaltFail) ? SMCError_Custom : SMCError_Okay;
dvander@2726: 						goto failed;
dvander@2726: 					}
dvander@2726: 					scrap(strings);
dvander@2726: 				}
dvander@2726: 
dvander@2726: 				/* Change the states for the next line */
dvander@2726: 				states.col = 0;
dvander@2726: 				states.line++;
dvander@2726: 				line_begin = &parse_point[i+1];		//Note: safe because this gets relocated later
dvander@2726: 			} 
dvander@2726: 			else if (ignoring) 
dvander@2726: 			{
dvander@2726: 				if (in_quote)
dvander@2726: 				{
dvander@2726: 					/* If i was 0, we could have reparsed, so make sure there's no buffer underrun */
dvander@2726: 					if ((&parse_point[i] != in_buf) && c == '"' && parse_point[i-1] != '\\')
dvander@2726: 					{
dvander@2726: 						/* If we reached a quote in an ignore phase,
dvander@2726: 						 * we're staging a string and we must rotate it out.
dvander@2726: 						 */
dvander@2726: 						in_quote = false;
dvander@2726: 						ignoring = false;
dvander@2726: 						/* Set our info */
dvander@2726: 						strings[0].end = &parse_point[i];
dvander@2726: 						strings[0].quoted = true;
dvander@2726: 						if (rotate(strings) != NULL)
dvander@2726: 						{
dvander@2726: 							/* If we rotated too many strings, there was too much crap on one line */
dvander@2726: 							err = SMCError_InvalidTokens;
dvander@2726: 							goto failed;
dvander@2726: 						}
dvander@2726: 					} 
dvander@2726: 					else if (c == '\\') 
dvander@2726: 					{
dvander@2726: 						strings[0].special = true;
dvander@2726: 						if (i == (read - 1))
dvander@2726: 						{
dvander@2726: 							reparse_point = &parse_point[i];
dvander@2726: 							break;
dvander@2726: 						}
dvander@2726: 					}
dvander@2726: 				} 
dvander@2726: 				else if (ml_comment) 
dvander@2726: 				{
dvander@2726: 					if (c == '*')
dvander@2726: 					{
dvander@2726: 						/* Check if we need to get more input first */
dvander@2726: 						if (i == read - 1)
dvander@2726: 						{
dvander@2726: 							reparse_point = &parse_point[i];
dvander@2726: 							break;
dvander@2726: 						}
dvander@2726: 						if (parse_point[i+1] == '/')
dvander@2726: 						{
dvander@2726: 							ml_comment = false;
dvander@2726: 							ignoring = false;
dvander@2726: 							/* We should not be staging anything right now. */
dvander@2726: 							assert(strings[0].ptr == NULL);
dvander@2726: 							/* Advance the input stream so we don't choke on this token */
dvander@2726: 							i++;
dvander@2726: 							states.col++;
dvander@2726: 						}
dvander@2726: 					}
dvander@2726: 				}
dvander@2726: 			} 
dvander@2726: 			else 
dvander@2726: 			{
dvander@2726: 				/* Check if we're whitespace or not */
dvander@2726: 				if (!g_ws_chartable[(unsigned char)c])
dvander@2726: 				{
dvander@2726: 					bool restage = false;
dvander@2726: 					/* Check various special tokens:
dvander@2726: 					 * ;
dvander@2726: 					 * //
dvander@2726: 					 * / *
dvander@2726: 					 * {
dvander@2726: 					 * }
dvander@2726: 					 */
dvander@2726: 					if (c == ';' || c == '/')
dvander@2726: 					{
dvander@2726: 						/* If it's a line-based comment (that is, ; or //)
dvander@2726: 						 * we will need to scrap everything until the end of the line.
dvander@2726: 						 */
dvander@2726: 						if (c == '/')
dvander@2726: 						{
dvander@2726: 							if (i == read - 1)
dvander@2726: 							{
dvander@2726: 								/* If we reached the end of the look-ahead, we need to re-check our input.
dvander@2726: 								 * Breaking out will force this to be the new reparse point!
dvander@2726: 								 */
dvander@2726: 								reparse_point = &parse_point[i];
dvander@2726: 								break;
dvander@2726: 							}
dvander@2726: 							if (parse_point[i + 1] == '/')
dvander@2726: 							{
dvander@2726: 								/* standard comment */
dvander@2726: 								ignoring = true;
dvander@2726: 								eol_comment = true;
dvander@2726: 								restage = true;
dvander@2726: 							} 
dvander@2726: 							else if (parse_point[i+1] == '*') 
dvander@2726: 							{
dvander@2726: 								/* inline comment - start ignoring */
dvander@2726: 								ignoring = true;
dvander@2726: 								ml_comment = true;
dvander@2726: 								/* yes, we restage, meaning that:
dvander@2726: 								 * STR/ *stuff* /ING  (space because ml comments don't nest in C++)
dvander@2726: 								 * will not generate 'STRING', but rather 'STR' and 'ING'.
dvander@2726: 								 * This should be a rare occurrence and is done here for convenience.
dvander@2726: 								 */
dvander@2726: 								restage = true;
dvander@2726: 							}
dvander@2726: 						} 
dvander@2726: 						else 
dvander@2726: 						{
dvander@2726: 							ignoring = true;
dvander@2726: 							eol_comment = true;
dvander@2726: 							restage = true;
dvander@2726: 						}
dvander@2726: 					} 
dvander@2726: 					else if (c == '{') 
dvander@2726: 					{
dvander@2726: 						/* If we are staging a string, we must rotate here */
dvander@2726: 						if (strings[0].ptr)
dvander@2726: 						{
dvander@2726: 							/* We have unacceptable tokens on this line */
dvander@2726: 							if (rotate(strings) != NULL)
dvander@2726: 							{
dvander@2726: 								err = SMCError_InvalidSection1;
dvander@2726: 								goto failed;
dvander@2726: 							}
dvander@2726: 						}
dvander@2726: 						/* Sections must always be alone */
dvander@2726: 						if (strings[2].ptr != NULL)
dvander@2726: 						{
dvander@2726: 							err = SMCError_InvalidSection1;
dvander@2726: 							goto failed;
dvander@2726: 						} 
dvander@2726: 						else if (strings[1].ptr == NULL)
dvander@2726: 						{
dvander@2726: 							err = SMCError_InvalidSection2;
dvander@2726: 							goto failed;
dvander@2726: 						}
dvander@2726: 						if ((res=smc->ReadSMC_NewSection(&states, FixupString(strings[1])))
dvander@2726: 							!= SMCResult_Continue)
dvander@2726: 						{
dvander@2726: 							err = (res == SMCResult_HaltFail) ? SMCError_Custom : SMCError_Okay;
dvander@2726: 							goto failed;
dvander@2726: 						}
dvander@2726: 						strings[1] = emptystring;
dvander@2726: 						curlevel++;
dvander@2726: 					} 
dvander@2726: 					else if (c == '}') 
dvander@2726: 					{
dvander@2726: 						/* Unlike our matching friend, this can be on the same line as something prior */
dvander@2726: 						if (rotate(strings) != NULL)
dvander@2726: 						{
dvander@2726: 							err = SMCError_InvalidSection3;
dvander@2726: 							goto failed;
dvander@2726: 						}
dvander@2726: 						if (strings[2].ptr)
dvander@2726: 						{
dvander@2726: 							if (!curlevel)
dvander@2726: 							{
dvander@2726: 								err = SMCError_InvalidProperty1;
dvander@2726: 								goto failed;
dvander@2726: 							}
dvander@2726: 							if ((res=smc->ReadSMC_KeyValue(
dvander@2726: 											&states,
dvander@2726: 											FixupString(strings[2]),
dvander@2726: 											FixupString(strings[1])))
dvander@2726: 								!= SMCResult_Continue)
dvander@2726: 							{
dvander@2726: 								err = (res == SMCResult_HaltFail) ? SMCError_Custom : SMCError_Okay;
dvander@2726: 								goto failed;
dvander@2726: 							}
dvander@2726: 						} 
dvander@2726: 						else if (strings[1].ptr) 
dvander@2726: 						{
dvander@2726: 							err = SMCError_InvalidSection3;
dvander@2726: 							goto failed;
dvander@2726: 						} 
dvander@2726: 						else if (!curlevel) 
dvander@2726: 						{
dvander@2726: 							err = SMCError_InvalidSection4;
dvander@2726: 							goto failed;
dvander@2726: 						}
dvander@2726: 						/* Now it's safe to leave the section */
dvander@2726: 						scrap(strings);
dvander@2726: 						if ((res=smc->ReadSMC_LeavingSection(&states)) != SMCResult_Continue)
dvander@2726: 						{
dvander@2726: 							err = (res == SMCResult_HaltFail) ? SMCError_Custom : SMCError_Okay;
dvander@2726: 							goto failed;
dvander@2726: 						}
dvander@2726: 						curlevel--;
dvander@2726: 					} 
dvander@2726: 					else if (c == '"') 
dvander@2726: 					{
dvander@2726: 						/* If we get a quote mark, we always restage, but we need to do it beforehand */
dvander@2726: 						if (strings[0].ptr)
dvander@2726: 						{
dvander@2726: 							strings[0].end = &parse_point[i];
dvander@2726: 							if (rotate(strings) != NULL)
dvander@2726: 							{
dvander@2726: 								err = SMCError_InvalidTokens;
dvander@2726: 								goto failed;
dvander@2726: 							}
dvander@2726: 						}
dvander@2726: 						strings[0].ptr = &parse_point[i];
dvander@2726: 						in_quote = true;
dvander@2726: 						ignoring = true;
dvander@2726: 					} 
dvander@2726: 					else if (!strings[0].ptr) 
dvander@2726: 					{
dvander@2726: 						/* If we have no string, we must start one */
dvander@2726: 						strings[0].ptr = &parse_point[i];
dvander@2726: 					}
dvander@2726: 					if (restage && strings[0].ptr)
dvander@2726: 					{
dvander@2726: 						strings[0].end = &parse_point[i];
dvander@2726: 						if (rotate(strings) != NULL)
dvander@2726: 						{
dvander@2726: 							err = SMCError_InvalidTokens;
dvander@2726: 							goto failed;
dvander@2726: 						}
dvander@2726: 					}
dvander@2726: 				} 
dvander@2726: 				else 
dvander@2726: 				{
dvander@2726: 					/* If we're eating a string and get whitespace, we need to restage.
dvander@2726: 					 * (Note that if we are quoted, this is being ignored)
dvander@2726: 					 */
dvander@2726: 					if (strings[0].ptr)
dvander@2726: 					{
dvander@2726: 						/*
dvander@2726: 						 * The specification says the second string in a pair does not need to be quoted.
dvander@2726: 						 * Thus, we check if there's already a string on the stack.
dvander@2726: 						 * If there's a newline, we always rotate so the newline has an empty starter.
dvander@2726: 						 */
dvander@2726: 						if (!strings[1].ptr)
dvander@2726: 						{
dvander@2726: 							/* There's no string, so we must move this one down and eat up another */
dvander@2726: 							strings[0].end = &parse_point[i];
dvander@2726: 							rotate(strings);
dvander@2726: 						} 
dvander@2726: 						else if (!strings[1].quoted) 
dvander@2726: 						{
dvander@2726: 							err = SMCError_InvalidTokens;
dvander@2726: 							goto failed;
dvander@2726: 						}
dvander@2726: 					}
dvander@2726: 				}
dvander@2726: 			}
dvander@2726: 
dvander@2726: 			/* Advance which token we're on */
dvander@2726: 			states.col++;
dvander@2726: 		}
dvander@2726: 
dvander@2726: 		if (line_begin != in_buf)
dvander@2726: 		{
dvander@2726: 			/* The line buffer has advanced, so it's safe to copy N bytes back to the beginning.
dvander@2726: 			 * What's N?  N is the lowest point we're currently relying on.
dvander@2726: 			 */
dvander@2726: 			char *stage = lowstring(strings);
dvander@2726: 			if (!stage || stage > line_begin)
dvander@2726: 			{
dvander@2726: 				stage = line_begin;
dvander@2726: 			}
dvander@2726: 			unsigned int bytes = read - (stage - parse_point);
dvander@2726: 
dvander@2726: 			/* It is now safe to delete everything before the staged point */
dvander@2726: 			memmove(in_buf, stage, bytes);
dvander@2726: 
dvander@2726: 			/* Calculate the number of bytes in the new buffer */
dvander@2726: 			bytes = stage - in_buf;
dvander@2726: 			/* Relocate all the cached pointers to our new base */
dvander@2726: 			line_begin -= bytes;
dvander@2726: 			reloc(strings[0], bytes);
dvander@2726: 			reloc(strings[1], bytes);
dvander@2726: 			reloc(strings[2], bytes);
dvander@2726: 			if (reparse_point)
dvander@2726: 			{
dvander@2726: 				reparse_point -= bytes;
dvander@2726: 			}
dvander@2726: 			if (parse_point)
dvander@2726: 			{
dvander@2726: 				parse_point = &parse_point[read];
dvander@2726: 				parse_point -= bytes;
dvander@2726: 			}
dvander@2726: 		} 
dvander@2726: 		else if (read == sizeof(in_buf) - 1) 
dvander@2726: 		{
dvander@2726: 			err = SMCError_TokenOverflow;
dvander@2726: 			goto failed;
dvander@2726: 		}
dvander@2726: 	}
dvander@2726: 
dvander@2726: 	/* If we're done parsing and there are tokens left over... */
dvander@2726: 	if (curlevel)
dvander@2726: 	{
dvander@2726: 		err = SMCError_InvalidSection5;
dvander@2726: 		goto failed;
dvander@2726: 	} 
dvander@2726: 	else if (strings[0].ptr || strings[1].ptr) 
dvander@2726: 	{
dvander@2726: 		err = SMCError_InvalidTokens;
dvander@2726: 		goto failed;
dvander@2726: 	}
dvander@2726: 	
dvander@2726: 	smc->ReadSMC_ParseEnd(false, false);
dvander@2726: 	
dvander@2726: 	if (pStates != NULL)
dvander@2726: 	{
dvander@2726: 		*pStates = states;
dvander@2726: 	}
dvander@2726: 
dvander@2726: 	return SMCError_Okay;
dvander@2726: 
dvander@2726: failed:
dvander@2726: 	if (pStates != NULL)
dvander@2726: 	{
dvander@2726: 		*pStates = states;
dvander@2726: 	}
dvander@2726: 
dvander@2726: 	smc->ReadSMC_ParseEnd(true, (err == SMCError_Custom));
dvander@2726: 
dvander@2726: 	return err;
dvander@2726: }
dvander@2726: 
dvander@2726: 
dvander@2726: /**
dvander@2726:  * INI parser 
dvander@2726:  */
dvander@2726: 
dvander@2726: bool TextParsers::ParseFile_INI(const char *file, ITextListener_INI *ini_listener, unsigned int *line, unsigned int *col)
dvander@2726: {
dvander@2726: 	FILE *fp = fopen(file, "rt");
dvander@2726: 	unsigned int curline = 0;
dvander@2726: 	unsigned int curtok;
dvander@2726: 	size_t len;
dvander@2726: 
dvander@2726: 	if (!fp)
dvander@2726: 	{
dvander@2726: 		if (line)
dvander@2726: 		{
dvander@2726: 			*line = 0;
dvander@2726: 		}
dvander@2726: 
dvander@2726: 		return false;
dvander@2726: 	}
dvander@2726: 
dvander@2726: 	char buffer[2048];
dvander@2726: 	char *ptr, *save_ptr;
dvander@2726: 	bool in_quote;
dvander@2726: 
dvander@2726: 	while (!feof(fp))
dvander@2726: 	{
dvander@2726: 		curline++;
dvander@2726: 		curtok = 0;
dvander@2726: 		buffer[0] = '\0';
dvander@2726: 		if (fgets(buffer, sizeof(buffer), fp) == NULL)
dvander@2726: 		{
dvander@2726: 			break;
dvander@2726: 		}
dvander@2726: 
dvander@2726: 		//:TODO: this will only run once, so find a nice way to move it out of the while loop
dvander@2726: 		/* If this is the first line, check the first three bytes for BOM */
dvander@2726: 		if (curline == 1 && 
dvander@2726: 			buffer[0] == (char)0xEF && 
dvander@2726: 			buffer[1] == (char)0xBB && 
dvander@2726: 			buffer[2] == (char)0xBF)
dvander@2726: 		{
dvander@2726: 			/* We have a UTF-8 marked file... skip these bytes */
dvander@2726: 			ptr = &buffer[3];
dvander@2726: 		} else {
dvander@2726: 			ptr = buffer;
dvander@2726: 		}
dvander@2726: 
dvander@2726: 		/***************************************************
dvander@2726: 		 * We preprocess the string before parsing tokens! *
dvander@2726: 		 ***************************************************/
dvander@2726: 
dvander@2726: 		/* First strip beginning whitespace */
dvander@2726: 		while (*ptr != '\0' && g_ws_chartable[(unsigned char)*ptr] != 0)
dvander@2726: 		{
dvander@2726: 			ptr++;
dvander@2726: 		}
dvander@2726: 
dvander@2726: 		len = strlen(ptr);
dvander@2726: 
dvander@2726: 		if (!len)
dvander@2726: 		{
dvander@2726: 			continue;
dvander@2726: 		}
dvander@2726: 
dvander@2726: 		/* Now search for comment characters */
dvander@2726: 		in_quote = false;
dvander@2726: 		save_ptr = ptr;
dvander@2726: 		for (size_t i=0; i<len; i++,ptr++)
dvander@2726: 		{
dvander@2726: 			if (!in_quote)
dvander@2726: 			{
dvander@2726: 				switch (*ptr)
dvander@2726: 				{
dvander@2726: 				case '"':
dvander@2726: 					{
dvander@2726: 						in_quote = true;
dvander@2726: 						break;
dvander@2726: 					}
dvander@2726: 				case ';':
dvander@2726: 					{
dvander@2726: 						/* Stop the loop */
dvander@2726: 						len = i;
dvander@2726: 						/* Terminate the string here */
dvander@2726: 						*ptr = '\0';
dvander@2726: 						break;
dvander@2726: 					}
dvander@2726: 				}
dvander@2726: 			} else {
dvander@2726: 				if (*ptr == '"')
dvander@2726: 				{
dvander@2726: 					in_quote = false;
dvander@2726: 				}
dvander@2726: 			}
dvander@2726: 		}
dvander@2726: 
dvander@2726: 		if (!len)
dvander@2726: 		{
dvander@2726: 			continue;
dvander@2726: 		}
dvander@2726: 
dvander@2726: 		ptr = save_ptr;
dvander@2726: 
dvander@2726: 		/* Lastly, strip ending whitespace off */
ds@3261: 		for (size_t i=len-1; i<len; i--)
dvander@2726: 		{
dvander@2726: 			if (g_ws_chartable[(unsigned char)ptr[i]])
dvander@2726: 			{
dvander@2726: 				ptr[i] = '\0';
dvander@2726: 				len--;
dvander@2726: 			} else {
dvander@2726: 				break;
dvander@2726: 			}
dvander@2726: 		}
dvander@2726: 
dvander@2726: 		if (!len)
dvander@2726: 		{
dvander@2726: 			continue;
dvander@2726: 		}
dvander@2726: 
dvander@2726: 		if (!ini_listener->ReadINI_RawLine(ptr, &curtok))
dvander@2726: 		{
dvander@2726: 			goto event_failed;
dvander@2726: 		}
dvander@2726: 
dvander@2726: 		if (*ptr == '[')
dvander@2726: 		{
dvander@2726: 			bool invalid_tokens = false;
dvander@2726: 			bool got_bracket = false;
dvander@2726: 			bool extra_tokens = false;
dvander@2726: 			char c;
dvander@2726: 			bool alnum;
dvander@2726: 			wchar_t wc;
dvander@2726: 
dvander@2726: 			for (size_t i=1; i<len; i++)
dvander@2726: 			{
dvander@2726: 				c = ptr[i];
dvander@2726: 				alnum = false;
dvander@2726: 
dvander@2726: 				if (c & (1<<7))
dvander@2726: 				{
dvander@2726: 					if (mbtowc(&wc, &ptr[i], len-i) != -1)
dvander@2726: 					{
dvander@2726: 						alnum = (iswalnum(wc) != 0);
dvander@2726: 						i += _GetUTF8CharBytes(&ptr[i]) - 1;
dvander@2726: 					}
dvander@2726: 				} else {
dvander@2726: 					alnum = (isalnum(c) != 0) || (g_ini_chartable1[(unsigned char)c] != 0);
dvander@2726: 				}
dvander@2726: 				if (!alnum)
dvander@2726: 				{
dvander@2726: 					/* First check - is this a bracket? */
dvander@2726: 					if (c == ']')
dvander@2726: 					{
dvander@2726: 						/* Yes! */
dvander@2726: 						got_bracket = true;
dvander@2726: 						/* If this isn't the last character... */
dvander@2726: 						if (i != len - 1)
dvander@2726: 						{
dvander@2726: 							extra_tokens = true;
dvander@2726: 						}
dvander@2726: 						/* terminate */
dvander@2726: 						ptr[i] = '\0';
dvander@2726: 						break;
dvander@2726: 					} else {
dvander@2726: 						/* n...No! Continue copying. */
dvander@2726: 						invalid_tokens = true;
dvander@2726: 					}
dvander@2726: 				}
dvander@2726: 			}
dvander@2726: 
dvander@2726: 			/* Tell the handler */
dvander@2726: 			if (!ini_listener->ReadINI_NewSection(&ptr[1], invalid_tokens, got_bracket, extra_tokens, &curtok))
dvander@2726: 			{
dvander@2726: 				goto event_failed;
dvander@2726: 			}
dvander@2726: 		} else {
dvander@2726: 			char *key_ptr = ptr;
dvander@2726: 			char *val_ptr = NULL;
dvander@2726: 			char c;
dvander@2726: 			size_t first_space = 0;
dvander@2726: 			bool invalid_tokens = false;
dvander@2726: 			bool equal_token = false;
dvander@2726: 			bool quotes = false;
dvander@2726: 			bool alnum;
dvander@2726: 			wchar_t wc;
dvander@2726: 
dvander@2726: 			for (size_t i=0; i<len; i++)
dvander@2726: 			{
dvander@2726: 				c = ptr[i];
dvander@2726: 				alnum = false;
dvander@2726: 				/* is this an invalid char? */
dvander@2726: 				if (c & (1<<7))
dvander@2726: 				{
dvander@2726: 					if (mbtowc(&wc, &ptr[i], len-i) != -1)
dvander@2726: 					{
dvander@2726: 						alnum = (iswalnum(wc) != 0);
dvander@2726: 						i += _GetUTF8CharBytes(&ptr[i]) - 1;
dvander@2726: 					}
dvander@2726: 				} else {
dvander@2726: 					alnum = (isalnum(c) != 0) || (g_ini_chartable1[(unsigned char)c] != 0);
dvander@2726: 				}
dvander@2726: 
dvander@2726: 				if (!alnum)
dvander@2726: 				{
dvander@2726: 					if (g_ws_chartable[(unsigned char)c])
dvander@2726: 					{
dvander@2726: 						/* if it's a space, keep track of the first occurring space */
dvander@2726: 						if (!first_space)
dvander@2726: 						{
dvander@2726: 							first_space = i;
dvander@2726: 						}
dvander@2726: 					} else {
dvander@2726: 						if (c == '=')
dvander@2726: 						{
dvander@2726: 							/* if it's an equal sign, we're done with the key */
dvander@2726: 							if (first_space)
dvander@2726: 							{
dvander@2726: 								/* remove excess whitespace */
dvander@2726: 								key_ptr[first_space] = '\0';
dvander@2726: 							} else {
dvander@2726: 								/* remove the equal sign */
dvander@2726: 								key_ptr[i] = '\0';
dvander@2726: 							}
dvander@2726: 							if (ptr[++i] != '\0')
dvander@2726: 							{
dvander@2726: 								/* If this isn't the end, set next pointer */
dvander@2726: 								val_ptr = &ptr[i];
dvander@2726: 							}
dvander@2726: 							equal_token = true;
dvander@2726: 							break;
dvander@2726: 						} else {
dvander@2726: 							/* Mark that we got something invalid! */
dvander@2726: 							invalid_tokens = true;
dvander@2726: 							first_space = 0;
dvander@2726: 						}
dvander@2726: 					}
dvander@2726: 				}
dvander@2726: 			}
dvander@2726: 
dvander@2726: 			/* Now we need to parse the value, if any */
dvander@2726: 			if (val_ptr)
dvander@2726: 			{
dvander@2726: 				/* eat up spaces! there shouldn't be any h*/
dvander@2726: 				while ((*val_ptr != '\0') && g_ws_chartable[(unsigned char)*val_ptr] != 0)
dvander@2726: 				{
dvander@2726: 					val_ptr++;
dvander@2726: 				}
dvander@2726: 				if (*val_ptr == '\0')
dvander@2726: 				{
dvander@2726: 					val_ptr = NULL;
dvander@2726: 					goto skip_value;
dvander@2726: 				}
dvander@2726: 				/* Do we have an initial quote? If so, the parsing rules change! */
dvander@2726: 				if (*val_ptr == '"' && *val_ptr != '\0')
dvander@2726: 				{
dvander@2726: 					len = strlen(val_ptr);
dvander@2726: 					if (val_ptr[len-1] == '"')
dvander@2726: 					{
dvander@2726: 						/* Strip quotes! */
dvander@2726: 						val_ptr[--len] = '\0';
dvander@2726: 						val_ptr++;
dvander@2726: 						quotes = true;
dvander@2726: 					}
dvander@2726: 				}
dvander@2726: 			}
dvander@2726: skip_value:
dvander@2726: 			/* We're done! */
dvander@2726: 			curtok = val_ptr - buffer;
dvander@2726: 			if (!ini_listener->ReadINI_KeyValue(key_ptr, val_ptr, invalid_tokens, equal_token, quotes, &curtok))
dvander@2726: 			{
dvander@2726: 				curtok = 0;
dvander@2726: 				goto event_failed;
dvander@2726: 			}
dvander@2726: 		}
dvander@2726: 	}
dvander@2726: 
dvander@2726: 	if (line)
dvander@2726: 	{
dvander@2726: 		*line = curline;
dvander@2726: 	}
dvander@2726: 
dvander@2726: 	fclose(fp);
dvander@2726: 
dvander@2726: 	return true;
dvander@2726: 
dvander@2726: event_failed:
dvander@2726: 	if (line)
dvander@2726: 	{
dvander@2726: 		*line = curline;
dvander@2726: 	}
dvander@2726: 
dvander@2726: 	if (col)
dvander@2726: 	{
dvander@2726: 		*col = curtok;
dvander@2726: 	}
dvander@2726: 
dvander@2726: 	fclose(fp);
dvander@2726: 
dvander@2726: 	return false;
dvander@2726: }
dvander@2726: 
dvander@2726: const char *TextParsers::GetSMCErrorString(SMCError err)
dvander@2726: {
dvander@2726: 	static const char *s_errors[] = 
dvander@2726: 	{
dvander@2726: 		NULL,
dvander@2726: 		"Stream failed to open",
dvander@2726: 		"Stream returned read error",
dvander@2726: 		NULL,
dvander@2726: 		"Un-quoted section has invalid tokens",
dvander@2726: 		"Section declared without header",
dvander@2726: 		"Section declared with unknown tokens",
dvander@2726: 		"Section ending without a matching section beginning",
dvander@2726: 		"Section beginning without a matching ending",
dvander@2726: 		"Line contained too many invalid tokens",
dvander@2726: 		"Token buffer overflowed",
dvander@2726: 		"A property was declared outside of a section",
dvander@2726: 	};
dvander@2726: 
dvander@2726: 	if (err < SMCError_Okay || err > SMCError_InvalidProperty1)
dvander@2726: 	{
dvander@2726: 		return NULL;
dvander@2726: 	}
dvander@2726: 
dvander@2726: 	return s_errors[err];
dvander@2726: }