Add sources and compilation guide

1 files changed, 529 insertions, 0 deletions

diff --git a/tools/preproc/asm_file.cpp b/tools/preproc/asm_file.cpp
new file mode 100644
index 0000000..383010a
--- /dev/null
+++ b/tools/preproc/asm_file.cpp
@@ -0,0 +1,529 @@
+// Copyright(c) 2016 YamaArashi
+//
+// Permission is hereby granted, free of charge, to any person obtaining a copy
+// of this software and associated documentation files (the "Software"), to deal
+// in the Software without restriction, including without limitation the rights
+// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+// copies of the Software, and to permit persons to whom the Software is
+// furnished to do so, subject to the following conditions:
+//
+// The above copyright notice and this permission notice shall be included in
+// all copies or substantial portions of the Software.
+//
+// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+// THE SOFTWARE.
+
+#include <cstdio>
+#include <cstdarg>
+#include "preproc.h"
+#include "asm_file.h"
+#include "char_util.h"
+#include "utf8.h"
+#include "string_parser.h"
+
+AsmFile::AsmFile(std::string filename) : m_filename(filename)
+{
+    FILE *fp = std::fopen(filename.c_str(), "rb");
+
+    if (fp == NULL)
+        FATAL_ERROR("Failed to open \"%s\" for reading.\n", filename.c_str());
+
+    std::fseek(fp, 0, SEEK_END);
+
+    m_size = std::ftell(fp);
+
+    if (m_size < 0)
+        FATAL_ERROR("File size of \"%s\" is less than zero.\n", filename.c_str());
+
+    m_buffer = new char[m_size + 1];
+
+    std::rewind(fp);
+
+    if (std::fread(m_buffer, m_size, 1, fp) != 1)
+        FATAL_ERROR("Failed to read \"%s\".\n", filename.c_str());
+
+    m_buffer[m_size] = 0;
+
+    std::fclose(fp);
+
+    m_pos = 0;
+    m_lineNum = 1;
+    m_lineStart = 0;
+
+    RemoveComments();
+}
+
+AsmFile::AsmFile(AsmFile&& other) : m_filename(std::move(other.m_filename))
+{
+    m_buffer = other.m_buffer;
+    m_pos = other.m_pos;
+    m_size = other.m_size;
+    m_lineNum = other.m_lineNum;
+    m_lineStart = other.m_lineStart;
+
+    other.m_buffer = nullptr;
+}
+
+AsmFile::~AsmFile()
+{
+    delete[] m_buffer;
+}
+
+// Removes comments to simplify further processing.
+// It stops upon encountering a null character,
+// which may or may not be the end of file marker.
+// If it's not, the error will be caught later.
+void AsmFile::RemoveComments()
+{
+    long pos = 0;
+    char stringChar = 0;
+
+    for (;;)
+    {
+        if (m_buffer[pos] == 0)
+            return;
+
+        if (stringChar != 0)
+        {
+            if (m_buffer[pos] == '\\' && m_buffer[pos + 1] == stringChar)
+            {
+                pos += 2;
+            }
+            else
+            {
+                if (m_buffer[pos] == stringChar)
+                    stringChar = 0;
+                pos++;
+            }
+        }
+        else if (m_buffer[pos] == '@' && (pos == 0 || m_buffer[pos - 1] != '\\'))
+        {
+            while (m_buffer[pos] != '\n' && m_buffer[pos] != 0)
+                m_buffer[pos++] = ' ';
+        }
+        else if (m_buffer[pos] == '/' && m_buffer[pos + 1] == '*')
+        {
+            m_buffer[pos++] = ' ';
+            m_buffer[pos++] = ' ';
+
+            for (;;)
+            {
+                if (m_buffer[pos] == 0)
+                    return;
+
+                if (m_buffer[pos] == '*' && m_buffer[pos + 1] == '/')
+                {
+                    m_buffer[pos++] = ' ';
+                    m_buffer[pos++] = ' ';
+                    break;
+                }
+                else
+                {
+                    if (m_buffer[pos] != '\n')
+                        m_buffer[pos] = ' ';
+                    pos++;
+                }
+            }
+        }
+        else
+        {
+            if (m_buffer[pos] == '"' || m_buffer[pos] == '\'')
+                stringChar = m_buffer[pos];
+            pos++;
+        }
+    }
+}
+
+// Checks if we're at a particular directive and if so, consumes it.
+// Returns whether the directive was found.
+bool AsmFile::CheckForDirective(std::string name)
+{
+    long i;
+    long length = static_cast<long>(name.length());
+
+    for (i = 0; i < length && m_pos + i < m_size; i++)
+        if (name[i] != m_buffer[m_pos + i])
+            return false;
+
+    if (i < length)
+        return false;
+
+    m_pos += length;
+
+    return true;
+}
+
+// Checks if we're at a known directive and if so, consumes it.
+// Returns which directive was found.
+Directive AsmFile::GetDirective()
+{
+    SkipWhitespace();
+
+    if (CheckForDirective(".include"))
+        return Directive::Include;
+    else if (CheckForDirective(".string"))
+        return Directive::String;
+    else if (CheckForDirective(".braille"))
+        return Directive::Braille;
+    else
+        return Directive::Unknown;
+}
+
+// Checks if we're at label that ends with '::'.
+// Returns the name if so and an empty string if not.
+std::string AsmFile::GetGlobalLabel()
+{
+    long start = m_pos;
+    long pos = m_pos;
+
+    if (IsIdentifierStartingChar(m_buffer[pos]))
+    {
+        pos++;
+
+        while (IsIdentifierChar(m_buffer[pos]))
+            pos++;
+    }
+
+    if (m_buffer[pos] == ':' && m_buffer[pos + 1] == ':')
+    {
+        m_pos = pos + 2;
+        ExpectEmptyRestOfLine();
+        return std::string(&m_buffer[start], pos - start);
+    }
+
+    return std::string();
+}
+
+// Skips tabs and spaces.
+void AsmFile::SkipWhitespace()
+{
+    while (m_buffer[m_pos] == '\t' || m_buffer[m_pos] == ' ')
+        m_pos++;
+}
+
+// Reads include path.
+std::string AsmFile::ReadPath()
+{
+    SkipWhitespace();
+
+    if (m_buffer[m_pos] != '"')
+        RaiseError("expected file path");
+
+    m_pos++;
+
+    int length = 0;
+    long startPos = m_pos;
+
+    while (m_buffer[m_pos] != '"')
+    {
+        unsigned char c = m_buffer[m_pos++];
+
+        if (c == 0)
+        {
+            if (m_pos >= m_size)
+                RaiseError("unexpected EOF in include string");
+            else
+                RaiseError("unexpected null character in include string");
+        }
+
+        if (!IsAsciiPrintable(c))
+            RaiseError("unexpected character '\\x%02X' in include string", c);
+
+        // Don't bother allowing any escape sequences.
+        if (c == '\\')
+        {
+            c = m_buffer[m_pos];
+            RaiseError("unexpected escape '\\%c' in include string", c);
+        }
+
+        length++;
+
+        if (length > kMaxPath)
+            RaiseError("path is too long");
+    }
+
+    m_pos++; // Go past the right quote.
+
+    ExpectEmptyRestOfLine();
+
+    return std::string(&m_buffer[startPos], length);
+}
+
+// Reads a charmap string.
+int AsmFile::ReadString(unsigned char* s)
+{
+    SkipWhitespace();
+
+    int length;
+    StringParser stringParser(m_buffer, m_size);
+
+    try
+    {
+        m_pos += stringParser.ParseString(m_pos, s, length);
+    }
+    catch (std::runtime_error& e)
+    {
+        RaiseError(e.what());
+    }
+
+    SkipWhitespace();
+
+    if (ConsumeComma())
+    {
+        SkipWhitespace();
+        int padLength = ReadPadLength();
+
+        while (length < padLength)
+        {
+            s[length++] = 0;
+        }
+    }
+
+    ExpectEmptyRestOfLine();
+
+    return length;
+}
+
+int AsmFile::ReadBraille(unsigned char* s)
+{
+    static std::map<char, unsigned char> encoding =
+    {
+        { 'A', 0x01 },
+        { 'B', 0x05 },
+        { 'C', 0x03 },
+        { 'D', 0x0B },
+        { 'E', 0x09 },
+        { 'F', 0x07 },
+        { 'G', 0x0F },
+        { 'H', 0x0D },
+        { 'I', 0x06 },
+        { 'J', 0x0E },
+        { 'K', 0x11 },
+        { 'L', 0x15 },
+        { 'M', 0x13 },
+        { 'N', 0x1B },
+        { 'O', 0x19 },
+        { 'P', 0x17 },
+        { 'Q', 0x1F },
+        { 'R', 0x1D },
+        { 'S', 0x16 },
+        { 'T', 0x1E },
+        { 'U', 0x31 },
+        { 'V', 0x35 },
+        { 'W', 0x2E },
+        { 'X', 0x33 },
+        { 'Y', 0x3B },
+        { 'Z', 0x39 },
+        { ' ', 0x00 },
+        { ',', 0x04 },
+        { '.', 0x2C },
+        { '$', 0xFF },
+    };
+
+    SkipWhitespace();
+
+    int length = 0;
+
+    if (m_buffer[m_pos] != '"')
+        RaiseError("expected braille string literal");
+
+    m_pos++;
+
+    while (m_buffer[m_pos] != '"')
+    {
+        if (length == kMaxStringLength)
+            RaiseError("mapped string longer than %d bytes", kMaxStringLength);
+
+        if (m_buffer[m_pos] == '\\' && m_buffer[m_pos + 1] == 'n')
+        {
+            s[length++] = 0xFE;
+            m_pos += 2;
+        }
+        else
+        {
+            char c = m_buffer[m_pos];
+
+            if (encoding.count(c) == 0)
+            {
+                if (IsAsciiPrintable(c))
+                    RaiseError("character '%c' not valid in braille string", m_buffer[m_pos]);
+                else
+                    RaiseError("character '\\x%02X' not valid in braille string", m_buffer[m_pos]);
+            }
+
+            s[length++] = encoding[c];
+            m_pos++;
+        }
+    }
+
+    m_pos++; // Go past the right quote.
+
+    ExpectEmptyRestOfLine();
+
+    return length;
+}
+
+// If we're at a comma, consumes it.
+// Returns whether a comma was found.
+bool AsmFile::ConsumeComma()
+{
+    if (m_buffer[m_pos] == ',')
+    {
+        m_pos++;
+        return true;
+    }
+
+    return false;
+}
+
+// Converts digit character to numerical value.
+static int ConvertDigit(char c, int radix)
+{
+    int digit;
+
+    if (c >= '0' && c <= '9')
+        digit = c - '0';
+    else if (c >= 'A' && c <= 'F')
+        digit = 10 + c - 'A';
+    else if (c >= 'a' && c <= 'f')
+        digit = 10 + c - 'a';
+    else
+        return -1;
+
+    return (digit < radix) ? digit : -1;
+}
+
+// Reads an integer. If the integer is greater than maxValue, it returns -1.
+int AsmFile::ReadPadLength()
+{
+    if (!IsAsciiDigit(m_buffer[m_pos]))
+        RaiseError("expected integer");
+
+    int radix = 10;
+
+    if (m_buffer[m_pos] == '0' && m_buffer[m_pos + 1] == 'x')
+    {
+        radix = 16;
+        m_pos += 2;
+    }
+
+    unsigned n = 0;
+    int digit;
+
+    while ((digit = ConvertDigit(m_buffer[m_pos], radix)) != -1)
+    {
+        n = n * radix + digit;
+
+        if (n > kMaxStringLength)
+            RaiseError("pad length greater than maximum length (%d)", kMaxStringLength);
+
+        m_pos++;
+    }
+
+    return n;
+}
+
+// Outputs the current line and moves to the next one.
+void AsmFile::OutputLine()
+{
+    while (m_buffer[m_pos] != '\n' && m_buffer[m_pos] != 0)
+        m_pos++;
+
+    if (m_buffer[m_pos] == 0)
+    {
+        if (m_pos >= m_size)
+        {
+            RaiseWarning("file doesn't end with newline");
+            puts(&m_buffer[m_lineStart]);
+        }
+        else
+        {
+            RaiseError("unexpected null character");
+        }
+    }
+    else
+    {
+        m_buffer[m_pos] = 0;
+        puts(&m_buffer[m_lineStart]);
+        m_buffer[m_pos] = '\n';
+        m_pos++;
+        m_lineStart = m_pos;
+        m_lineNum++;
+    }
+}
+
+// Asserts that the rest of the line is empty and moves to the next one.
+void AsmFile::ExpectEmptyRestOfLine()
+{
+    SkipWhitespace();
+
+    if (m_buffer[m_pos] == 0)
+    {
+        if (m_pos >= m_size)
+            RaiseWarning("file doesn't end with newline");
+        else
+            RaiseError("unexpected null character");
+    }
+    else if (m_buffer[m_pos] == '\n')
+    {
+        m_pos++;
+        m_lineStart = m_pos;
+        m_lineNum++;
+    }
+    else if (m_buffer[m_pos] == '\r')
+    {
+        RaiseError("only Unix-style LF newlines are supported");
+    }
+    else
+    {
+        RaiseError("junk at end of line");
+    }
+}
+
+// Checks if we're at the end of the file.
+bool AsmFile::IsAtEnd()
+{
+    return (m_pos >= m_size);
+}
+
+// Output the current location to set gas's logical file and line numbers.
+void AsmFile::OutputLocation()
+{
+    std::printf("# %ld \"%s\"\n", m_lineNum, m_filename.c_str());
+}
+
+// Reports a diagnostic message.
+void AsmFile::ReportDiagnostic(const char* type, const char* format, std::va_list args)
+{
+    const int bufferSize = 1024;
+    char buffer[bufferSize];
+    std::vsnprintf(buffer, bufferSize, format, args);
+    std::fprintf(stderr, "%s:%ld: %s: %s\n", m_filename.c_str(), m_lineNum, type, buffer);
+}
+
+#define DO_REPORT(type)                   \
+do                                        \
+{                                         \
+    std::va_list args;                    \
+    va_start(args, format);               \
+    ReportDiagnostic(type, format, args); \
+    va_end(args);                         \
+} while (0)
+
+// Reports an error diagnostic and terminates the program.
+void AsmFile::RaiseError(const char* format, ...)
+{
+    DO_REPORT("error");
+    std::exit(1);
+}
+
+// Reports a warning diagnostic.
+void AsmFile::RaiseWarning(const char* format, ...)
+{
+    DO_REPORT("warning");
+}