symbols.h

Go to the documentation of this file.

/*
 * Copyright (c) 2013 Daniel Loffgren
 *
 * 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.
 */

#ifndef as6502_symbols_h
#define as6502_symbols_h

#include <stdint.h>

#include <as6502/token.h>

#define as6502_symbolTypeIsLinked(_type)        (_type == as6502_symbol_type_label || _type == as6502_symbol_type_variable)

#define as6502_symbolTypeIsLabel(_type)         (_type == as6502_symbol_type_label || _type == as6502_symbol_type_label_unlinked)

#define as6502_symbolTypeIsVariable(_type)      (_type == as6502_symbol_type_variable || _type == as6502_symbol_type_variable_unlinked)

typedef enum {
    as6502_symbol_type_unknown = 0,
    as6502_symbol_type_label = 2,
    as6502_symbol_type_variable = 3,
    as6502_symbol_type_label_unlinked = 4,
    as6502_symbol_type_variable_unlinked = 5
} as6502_symbol_type;

typedef struct  _as6502_symbol  {
    struct _as6502_symbol *next;
    unsigned long line;
    char *name;
    uint16_t address;
    as6502_symbol_type type;
} as6502_symbol;

typedef struct {
    as6502_symbol *first_symbol;
} as6502_symbol_table;

as6502_symbol_table *as6502_createSymbolTable(void);
void as6502_destroySymbolTable(as6502_symbol_table *table);
void as6502_printSymbolTable(as6502_symbol_table *table);
void as6502_printSymbolScript(as6502_symbol_table *table, FILE *out);
as6502_symbol *as6502_symbolForString(as6502_symbol_table *table, const char *name);
as6502_symbol *as6502_symbolForAddress(as6502_symbol_table *table, uint16_t address);
uint16_t as6502_addressForSymbolByName(as6502_symbol_table *table, const char *name);
void as6502_addSymbolToTable(as6502_symbol_table *table, unsigned long line, const char *name, uint16_t address, as6502_symbol_type type);
void as6502_removeSymbolFromTable(as6502_symbol_table *table, as6502_symbol *symbol);
void as6502_truncateTableToAddressSpace(as6502_symbol_table *table, uint16_t start, uint16_t len);
as6502_token *as6502_desymbolicateExpression(as6502_symbol_table *table, as6502_token *head, uint16_t offset, int caseSensitive);

void as6502_symbolicateLine(as6502_symbol_table *table, char *line, size_t len, uint16_t offset);
void as6502_replaceSymbolInLineAtLocationWithText(char *line, size_t len, char *loc, const char * restrict symbol, const char * restrict text);
int as6502_symbolShouldBeReplacedDoubleWidth(as6502_token *instruction);
#endif