IRP.cpp

///////////////////////////////////////////////////////////////////////////////
// MakeHex version 4  Copyright 2004 John S. Fine
//
// You may use, copy, modify and/or distribute this program for private or
// commercial use provided that:
//
// 1)  You do not hold me responsible for any damage or negative consequences
// resulting from those activities.
//
// 2)  You include this copyright notice and disclaimer in any copy of any part
// or all of this program.
//
// I do not provide any warranty of the correctness, safety, or suitibility of
// this program for any purpose.
//
// If you do not agree to these conditions, you have no permission to use, copy,
// modify or distribute this program.
///////////////////////////////////////////////////////////////////////////////

#include "StdAfx.h"
#include "IRP.h"

#pragma GCC diagnostic ignored "-Wwrite-strings"
#pragma GCC diagnostic ignored "-Wformat="

//////////////////////////////////////////////////////////////////////
// Construction/Destruction
//////////////////////////////////////////////////////////////////////

IRP::IRP() :
	m_frequency(38400.),
	m_timeBase(1.),
	m_messageTime(0.),
    m_prefix(0),
	m_suffix(0),
	m_rPrefix(0),
	m_rSuffix(0),
	m_msb(false),
	m_form(0),
	m_numberFormat(0),
    m_bitGroup(2)
{
	memset(m_digits, 0, sizeof(m_digits));
	memset(m_def, 0, sizeof(m_def));
	memset(m_value, 0, sizeof(m_value));
	memset(m_device, -1, sizeof(m_device));
	memset(m_functions, -1, sizeof(m_functions));
    m_mask[0] = 0;
    for (int ndx=1; ndx<33; ++ndx)
        m_mask[ndx] = 2*m_mask[ndx-1]+1;
}

IRP::~IRP()
{

}

unsigned int reverse(unsigned int Number)
{
	Number = ((Number & 0x55555555) << 1) + ((Number >> 1) & 0x55555555);
	Number = ((Number & 0x33333333) << 2) + ((Number >> 2) & 0x33333333);
	Number = ((Number & 0xF0F0F0F)  << 4) + ((Number >> 4) & 0xF0F0F0F);
	Number = ((Number & 0xFF00FF)   << 8) + ((Number >> 8) & 0xFF00FF);
	return (Number>>16) + (Number<<16);
}

bool IRP::match(char *master)
{
	int len = strlen(master);
	m_next = m_bufr+len;
	return 0==memcmp(m_bufr, master, len);
}

void IRP::setDigit(int d)
{
    m_digits[d] = copy();
    while ( d >= m_bitGroup )
    {
        m_bitGroup <<= 1;
    }
}

bool IRP::readIrpFile(FILE *InFile)
{
	for (;;)
	{
        Value val;

		// Read a line from the file
		char *line = fgets(m_bufr, sizeof(m_bufr), InFile);
		if (!line)
			break;

		// Convert to upper case, compress out blanks and discard comments
		for (char *l2 = line; *l2 && *l2!='\'' && *l2!='\n'; l2++)
		{
			if (*l2 != ' ' && *l2 != '\t')
				*(line++) = toupper(*l2);
		}
		*line = 0;

		// Recognise some Keywords

		if (match("FREQUENCY="))
		{
            parseVal(val, m_next);
			m_frequency = val.m_val;
		}
		else if (match("TIMEBASE="))
		{
            parseVal(val, m_next);
			m_timeBase = val.m_val;
		}
		else if (match("MESSAGETIME="))
		{
            parseVal(val, m_next);
            if ( val.m_bits == 0 )
                val.m_val *= m_timeBase;
			m_messageTime = val.m_val;
		}
		else if (m_bufr[0]>='0' && m_bufr[0]<='9' && m_bufr[1]=='=')
        {
            m_next=m_bufr+2;
            setDigit(m_bufr[0]-'0');
        }
		else if (m_bufr[0]=='1' && m_bufr[1]>='0' && m_bufr[1]<='5' && m_bufr[2]=='=')
        {
            m_next=m_bufr+3;
            setDigit(m_bufr[1]+(10-'0'));
        }
		else if (match("ZERO="))
		{
			setDigit(0);
		}
		else if (match("ONE="))
		{
			setDigit(1);
		}
		else if (match("TWO="))
		{
			setDigit(2);
		}
		else if (match("THREE="))
		{
			setDigit(3);
		}
		else if (match("PREFIX="))
		{
			m_prefix = copy();
		}
		else if (match("SUFFIX="))
		{
			m_suffix = copy();
		}
		else if (match("R-PREFIX="))
		{
			m_rPrefix = copy();
		}
		else if (match("R-SUFFIX="))
		{
			m_rSuffix = copy();
		}
		else if (match("FIRSTBIT=MSB"))
		{
			m_msb = true;
		}
		else if (match("FORM="))
		{
			m_form = copy();
		}
		else if (match("DEFINE") || match("DEFAULT"))
		{
			if (m_next[1] == '=')
			{	// define x = ...
				m_next += 2;
				m_def[m_next[-2]-'A'] = copy();
			}
			else if (m_next[0] == '=' && m_next[2]=='A' && m_next[3]=='S')
			{	// define = x as ...
				m_next += 4;
				m_def[m_next[-3]-'A'] = copy();
			}
			else if (m_next[1]=='A' && m_next[2]=='S')
			{	// define x as ...
				m_next += 3;
				m_def[m_next[-3]-'A'] = copy();
			}
		}
		else if (match("DEVICE="))
		{
			getPair(m_device);
		}
		else if (match("FUNCTION="))
		{
			getPair(m_functions);
			if (m_next[0]=='.' && m_next[1]=='.')
			{
				m_next += 2;
				getPair(m_functions+2);
			}
		}
	}

	if (m_device[1] >= 0)
		m_def['S' - 'A'] = 0;
	if (m_functions[1] >= 0)
		m_def['N' - 'A'] = 0;

	if (   !m_form
		|| m_digits[0] == 0
		|| m_digits[1] == 0
		|| m_functions[0] == -1
		|| m_functions[2] >= 0 && m_functions[2] != m_functions[0] && m_functions[3] != m_functions[1]
		)
	{
		return false;
	}
	return true;
}

bool IRP::readIrpString(char *str)
{
	char *line = strtok(str, "\n");
	while (line != NULL && line[0] != 0)
	{
		strcpy(m_bufr, line);
		line = m_bufr;
		
        Value val;

		// Convert to upper case, compress out blanks and discard comments
		for (char *l2 = line; *l2 && *l2!='\'' && *l2!='\n'; l2++)
		{
			if (*l2 != ' ' && *l2 != '\t')
				*(line++) = toupper(*l2);
		}
		*line = 0;

		// Recognise some Keywords

		if (match("FREQUENCY="))
		{
            parseVal(val, m_next);
			m_frequency = val.m_val;
		}
		else if (match("TIMEBASE="))
		{
            parseVal(val, m_next);
			m_timeBase = val.m_val;
		}
		else if (match("MESSAGETIME="))
		{
            parseVal(val, m_next);
            if ( val.m_bits == 0 )
                val.m_val *= m_timeBase;
			m_messageTime = val.m_val;
		}
		else if (m_bufr[0]>='0' && m_bufr[0]<='9' && m_bufr[1]=='=')
        {
            m_next=m_bufr+2;
            setDigit(m_bufr[0]-'0');
        }
		else if (m_bufr[0]=='1' && m_bufr[1]>='0' && m_bufr[1]<='5' && m_bufr[2]=='=')
        {
            m_next=m_bufr+3;
            setDigit(m_bufr[1]+(10-'0'));
        }
		else if (match("ZERO="))
		{
			setDigit(0);
		}
		else if (match("ONE="))
		{
			setDigit(1);
		}
		else if (match("TWO="))
		{
			setDigit(2);
		}
		else if (match("THREE="))
		{
			setDigit(3);
		}
		else if (match("PREFIX="))
		{
			m_prefix = copy();
		}
		else if (match("SUFFIX="))
		{
			m_suffix = copy();
		}
		else if (match("R-PREFIX="))
		{
			m_rPrefix = copy();
		}
		else if (match("R-SUFFIX="))
		{
			m_rSuffix = copy();
		}
		else if (match("FIRSTBIT=MSB"))
		{
			m_msb = true;
		}
		else if (match("FORM="))
		{
			m_form = copy();
		}
		else if (match("DEFINE") || match("DEFAULT"))
		{
			if (m_next[1] == '=')
			{	// define x = ...
				m_next += 2;
				m_def[m_next[-2]-'A'] = copy();
			}
			else if (m_next[0] == '=' && m_next[2]=='A' && m_next[3]=='S')
			{	// define = x as ...
				m_next += 4;
				m_def[m_next[-3]-'A'] = copy();
			}
			else if (m_next[1]=='A' && m_next[2]=='S')
			{	// define x as ...
				m_next += 3;
				m_def[m_next[-3]-'A'] = copy();
			}
		}
		else if (match("DEVICE="))
		{
			getPair(m_device);
		}
		else if (match("FUNCTION="))
		{
			getPair(m_functions);
			if (m_next[0]=='.' && m_next[1]=='.')
			{
				m_next += 2;
				getPair(m_functions+2);
			}
		}
		
		line = strtok(NULL, "\n");
	}

	if (m_device[1] >= 0)
		m_def['S' - 'A'] = 0;
	if (m_functions[1] >= 0)
		m_def['N' - 'A'] = 0;

	if (   !m_form
		|| m_digits[0] == 0
		|| m_digits[1] == 0
		|| m_functions[0] == -1
		|| m_functions[2] >= 0 && m_functions[2] != m_functions[0] && m_functions[3] != m_functions[1]
		)
	{
		return false;
	}
	return true;
}

void IRP::Parse(std::vector<float> &result)
{
    m_hex.clear();
    m_hex.push_back(0.0);
    genHex(m_next);
    result = m_hex;
}

char *IRP::copy()
{
	char *result = new char [strlen(m_next)+1];
	strcpy(result, m_next);
	return result;
}

void IRP::getPair(int *result)
{
	for (int nIndex=0; nIndex<2; nIndex++)
	{
		int num=0;
		for (;*m_next;m_next++)
		{
			if (*m_next>='0' && *m_next<='9')
				num = num * 10 + *m_next - '0';
			else
				break;
		}
		result[nIndex] = num;
		if (m_next[0] != '.' || m_next[1]<'0' || m_next[1]>'9')
			break;
		m_next++;
	}
}

void IRP::writeHex(FILE *OutFile)
{
	static const char* (fmts[]) =
	{
		" %d",
		" %02X",
		" %d (0x%02X)",
		" %d.%d",
		" %02X.%02X",
		" %d.%d (0x%02X.0x%02X)"
	};
	m_function[0] = m_functions[0];
	do
	{
		m_function[1] = m_functions[1];
		do
		{
			m_value['D' - 'A'] = m_device[0];
			m_value['S' - 'A'] = m_device[1];
			m_value['F' - 'A'] = m_function[0];
			m_value['N' - 'A'] = m_function[1];

            fprintf(OutFile, "Device Code:");
			if (m_device[1] >= 0)
				fprintf(OutFile, fmts[3+m_numberFormat], m_device[0], m_device[1], m_device[0], m_device[1]);
			else
				fprintf(OutFile, fmts[m_numberFormat], m_device[0], m_device[0]);
			fprintf(OutFile, " Function:");
			if (m_function[1] >= 0)
				fprintf(OutFile, fmts[3+m_numberFormat], m_function[0], m_function[1], m_function[0], m_function[1]);
			else
				fprintf(OutFile, fmts[m_numberFormat], m_function[0], m_function[0]);
			fprintf(OutFile, "\n");
			generate(OutFile);
		} while (++m_function[1] <= m_functions[3]);
	} while (++m_function[0] <= m_functions[2]);
}

void IRP::generate(FILE *OutFile)
{
	m_hex.clear();
	m_cumulative=0.0;
    m_pendingBits = (m_msb ? 1 : m_bitGroup);
	int Single = genHex(m_form);
    if (m_cumulative<m_messageTime)
		genHex(m_cumulative - m_messageTime);
    if (m_hex.size() & 1)
        genHex(-1.0);
    if (Single < 0)
        Single = m_hex.size();
    Single >>= 1;

	int unit;
	if (m_frequency)
	{
		fprintf(OutFile, "0000");
		unit = floor(4145146. / m_frequency + 0.5);
	}
	else
	{
		fprintf(OutFile, "0100");
		float mn = m_hex[0];
		for (int nIndex=1; nIndex<m_hex.size(); nIndex++)
			if (mn > m_hex[nIndex])
				mn = m_hex[nIndex];
		unit = 4.145146*.125 * mn + 0.5;
		unit &= -2;
	}
    if (unit <= 0)
        unit = 1;
	fprintf(OutFile, " %04X %04X %04X", unit, Single, m_hex.size()/2 - Single);
	for (int nIndex=0; nIndex<m_hex.size(); nIndex+=2)
	{
        int v1 = floor( m_hex[nIndex]*4.145146/unit+0.5 );
        if ( v1 == 0 )
            v1 = 1;
        if ( v1 > 0xFFFF )
            v1 = 0xFFFF;
        int v2 = floor( (m_hex[nIndex]+m_hex[nIndex+1])*4.145146/unit+0.5 ) - v1;
        if ( v2 == 0 )
            v2 = 1;
        if ( v2 > 0xFFFF )
            v2 = 0xFFFF;
		fprintf(OutFile, " %04X %04X", v1, v2);
	}
	fprintf(OutFile, "\n");
}

void IRP::generate(int *s, int *r, float *raw)
{
	m_hex.clear();
	m_cumulative=0.0;
    m_pendingBits = (m_msb ? 1 : m_bitGroup);
	int Single = genHex(m_form);
    if (m_cumulative<m_messageTime)
		genHex(m_cumulative - m_messageTime);
    if (m_hex.size() & 1)
        genHex(-1.0);
    if (Single < 0)
        Single = m_hex.size();
    Single >>= 1;

	int unit;
	if (m_frequency)
	{
//		printf("0000");
		unit = floor(4145146. / m_frequency + 0.5);
	}
	else
	{
//		printf("0100");
		float mn = m_hex[0];
		for (int nIndex=1; nIndex<m_hex.size(); nIndex++)
			if (mn > m_hex[nIndex])
				mn = m_hex[nIndex];
		unit = 4.145146*.125 * mn + 0.5;
		unit &= -2;
	}
    if (unit <= 0)
        unit = 1;
//	printf(" %04X %04X %04X", unit, Single, m_hex.size()/2 - Single);
	for (int nIndex=0; nIndex<m_hex.size(); nIndex+=2)
	{
		raw[nIndex] = m_hex[nIndex];
		raw[nIndex + 1] = m_hex[nIndex + 1];
        int v1 = floor( m_hex[nIndex]*4.145146/unit+0.5 );
        if ( v1 == 0 )
            v1 = 1;
        if ( v1 > 0xFFFF )
            v1 = 0xFFFF;
        int v2 = floor( (m_hex[nIndex]+m_hex[nIndex+1])*4.145146/unit+0.5 ) - v1;
        if ( v2 == 0 )
            v2 = 1;
        if ( v2 > 0xFFFF )
            v2 = 0xFFFF;
//		printf(" %04X %04X", v1, v2);
	}
//	printf("\n");
	
	*s = Single;
	*r = m_hex.size()/2 - Single;
	return;
}

int IRP::genHex(char *Pattern)
{
	int Result = -1;
	if (*Pattern == ';')
	{
		Result = 0;         // Single section is empty
		Pattern++;
	}
	while (*Pattern)
	{
		if (*Pattern == '*')
		{
			genHex( (Result>=0 && m_rPrefix) ? m_rPrefix : m_prefix );
			Pattern++;
		}
		else if (*Pattern == '_')
		{
			genHex( (Result>=0 && m_rSuffix) ? m_rSuffix : m_suffix );
			Pattern++;
			if (m_cumulative<m_messageTime)
            {
                genHex(m_cumulative - m_messageTime);
            }
		}
		else if (*Pattern == '^')
		{
			Pattern++;

            Value val;
            parseVal(val, Pattern);
            if ( val.m_bits == 0 )
                val.m_val *= m_timeBase;

			if (m_cumulative<val.m_val)
            {
                genHex(m_cumulative - val.m_val);
            }
		}
		else
		{
            Value val;
            parseVal(val, Pattern);

            if ( val.m_bits == 0 )
                val.m_val *= m_timeBase;
            if ( val.m_bits <= 0 )
            {
                genHex(val.m_val);
            }
            else
            {
                int Number = (int)(val.m_val);
                if (m_msb)
                    Number = reverse(Number) >> (32-val.m_bits);
			    while (--val.m_bits >= 0)
			    {
                    if (m_msb)
                    {
                        m_pendingBits = (m_pendingBits << 1) + (Number & 1);
                        if ( m_pendingBits & m_bitGroup )
                        {
				            genHex( m_digits[m_pendingBits-m_bitGroup] );
                            m_pendingBits = 1;
                        }
                    }
                    else
                    {
                        m_pendingBits = (m_pendingBits >> 1) + (Number & 1)*m_bitGroup;
                        if ( m_pendingBits & 1 )
                        {
				            genHex( m_digits[m_pendingBits>>1] );
                            m_pendingBits = m_bitGroup;
                        }
                    }
				    Number >>= 1;
			    }
            }
		}
		if (*Pattern == ';')
		{
			if (m_cumulative<m_messageTime)
            {
                genHex(m_cumulative - m_messageTime);
            }
			if (m_hex.size() & 1)
			{
                genHex(-1.0);
			}
			Result = m_hex.size();
			m_cumulative = 0.0;
		}
		else if (*Pattern != ',')
			break;
		Pattern++;
	}
    return Result;
}  // genHex(char *Pattern)

void IRP::genHex(std::vector<float>& Sequence)
{
	for (int nIndex=0; ; )
	{
        if ( nIndex >= Sequence.size() )
            break;
		genHex( Sequence[nIndex++] );
        if ( nIndex >= Sequence.size() )
            break;
		genHex( -Sequence[nIndex++] );
	}
}

void IRP::genHex(float number)
{
    if (number == 0.0)
        return;
	int nHex = m_hex.size();
	if (number > 0)
	{
		m_cumulative += number;
		if (nHex & 1)
			m_hex[nHex - 1] += number;
		else
			m_hex.push_back(number);
	}
	else if (nHex)
	{
		m_cumulative -= number;
		if (nHex & 1)
			m_hex.push_back(-number);
		else
			m_hex[nHex - 1] -= number;
	}
}

int IRP::value0(char *&eq)
{
	if (*eq >= 'A' && *eq <= 'Z')
		return m_value[*eq++ - 'A'];
	int result = 0;
	while (*eq >= '0' && *eq <= '9')
	{
		result = result * 10 + *eq - '0';
		eq++;
	}
	return result;
}

int IRP::value1(char *&eq)
{
	if (*eq == '~')
	{
		eq++;
		return -1 - value0(eq);
	}
    if (*eq == '-')
    {
        eq++;
        return -value0(eq);
    }
	return value0(eq);
}

int IRP::value2(char *&eq)
{
	int Result = value1(eq);
	if (*eq == '(')
	{
		eq++;
		int first = value0(eq);
		if (eq[0] == '.' && eq[1] == '.')
		{
			eq += 2;
			int second = value0(eq);
			if (*eq == ')')
			{
				eq++;
				Result >>= first;
				Result &= (2<<(second-first))-1;
			}
		}
	}
	return Result;
}

void IRP::parseVal(Value& result, char*& in, int prec /* = 0 */)
{
    if (*in >= 'A' && *in <= 'Z')
    {
        int ndx = *(in++) - 'A';
        char *in2 = m_def[ndx];
        if (in2)
        {
            parseVal(result, in2, 0);
            if (*in2)
            {
                // error
            }
        }
        else
        {
            result.m_val = m_value[ndx];
            result.m_bits = 0;
        }
    }
    else if (*in >= '0' && *in <= '9')
    {
        result.m_bits = 0;
        result.m_val = 0.0;
        do
        {
            result.m_val = result.m_val*10 + *(in++) - '0';
        
        } while (*in >= '0' && *in <= '9');
    }
    else switch ( *in )
    {
        case '-':
            ++in;
            parseVal(result, in, unary);
            result.m_val = - result.m_val;
            if ( result.m_bits > 0 )
                result.m_bits = 0;
            break;
        case '~':
            ++in;
            parseVal(result, in, unary);
            result.m_val = - ( result.m_val + 1 );
            if ( result.m_bits > 0 )
                result.m_val = (double)( ((int)result.m_val) & m_mask[result.m_bits] );
            break;
        case '(':
            ++in;
            parseVal(result, in, 0);
            if (*in == ')')
            {
                ++in;
            }
            else
            {
                // error
            }
            break;
        default:
            // error
            break;
    }

    if (*in == 'M')
    {
        result.m_val *= 1000;
        result.m_bits = -1;
        ++in;
    }
    else if (*in == 'U')
    {
        result.m_bits = -1;
        ++in;
    }

    for (;;)
    {
        Value v2;
        if ( prec < times )
        {
            if (*in == '*')
            {
                ++in;
                parseVal(v2, in, times);
                result.m_val *= v2.m_val;
                if ( result.m_bits > 0 )
                    result.m_bits = 0;
                continue;
            }
        }
        if ( prec < plus )
        {
            switch (*in)
            {
                case '+':
                    ++in;
                    parseVal(v2, in, plus);
                    result.m_val += v2.m_val;
                    if ( result.m_bits > 0 )
                        result.m_bits = 0;
                    continue;
                case '-':
                    ++in;
                    parseVal(v2, in, plus);
                    result.m_val -= v2.m_val;
                    if ( result.m_bits > 0 )
                        result.m_bits = 0;
                    continue;
                case '^':
                    ++in;
                    parseVal(v2, in, plus);
                    result.m_val = ((int)result.m_val) ^ ((int)v2.m_val);
                    if ( result.m_bits > 0 && ( v2.m_bits<=0 || v2.m_bits>result.m_bits ) )
                        result.m_bits = v2.m_bits;
                    continue;
            }
        }
        if ( prec < colon )
        {
            if (*in == ':')
            {
                ++in;
                parseVal(v2, in, colon);
                result.m_bits = v2.m_val;
                if (*in == ':')
                {
                    ++in;
                    parseVal(v2, in, colon);
                    result.m_val = (double)( ((int)result.m_val) >> ((int)v2.m_val) );
                }
                if ( result.m_bits < 0 )
                {
                    result.m_bits = -result.m_bits;
                    result.m_val = (double)( reverse((int)result.m_val) >> (32-result.m_bits) );
                }
                result.m_val = (double)( ((int)result.m_val) & m_mask[result.m_bits] );
                continue;
            }
        }
        break;
    }
}  // parseVal