symbol.c File Reference

#include "symbol.h"
#include "../encode.h"
#include "../defs.h"
#include "exception.h"
#include "util.h"
#include <ctype.h>
#include <string.h>

Functions
int	build_instruction (instruction_t *ins, symbol_list_t *symbols, int idx)
	Build an instruction from symbols beginning at idx. More...
int	is_comment (const char *s)
	Check if the given string is a comment. More...
int	is_db (const char *s)
	Check if given string is a DB identifier. More...
int	is_dw (const char *s)
	Check if given string is a DW identifier. More...
int	is_instruction (const char *s)
	Check if the given string is an instruction. More...
int	is_label_definition (const char *s)
	Check if the given string is a label definition. More...
int	is_label (const char *s, label_list_t *labels)
	Check if given string is a label reference. More...
int	is_register (const char *s)
	Check if the given string represents a V register. More...
int	is_reserved_identifier (const char *s)
	Check if given string is a reserved identifier. More...
symbol_t *	next_symbol (symbol_list_t *symbols)
	Get the next symbol. More...
int	populate_labels (char **lines, int lineCount, label_list_t *labels)
	Populate label list from lines. More...
int	resolve_labels (symbol_list_t *symbols, label_list_t *labels)
	Get byte indexes of label definitions from completed symbol table. More...
int	substitute_labels (symbol_list_t *symbols, label_list_t *labels)
	Substitute label symbols with their corresponding int value. More...

Variables
const char *	c8_identifierStrings []
const char *	c8_instructionStrings []
instruction_format_t	formats []

Detailed Description

Note

NOT EXPORTED

Stuff for parsing symbols and instructions for encoding CHIP-8 "assembly".

Function Documentation

build_instruction()

int build_instruction	(	instruction_t *	ins,
		symbol_list_t *	symbols,
		int	idx
	)

Build an instruction from symbols beginning at idx.

This function builds an instruction from a completely parsed set of symbols (with labels expanded).

Parameters

ins	instruction_t to store instruction contents
symbols	symbol list
idx	symbols index of start of instruction

Returns

instruction bytecode

is_comment()

int is_comment

(

const char *

s

)

Check if the given string is a comment.

Parameters

s	the string to check

Returns

1 if true, 0 if false

is_db()

int is_db

(

const char *

s

)

Check if given string is a DB identifier.

Returns

1 if true, 0 if false

is_dw()

int is_dw

(

const char *

s

)

Check if given string is a DW identifier.

Returns

1 if true, 0 if false

is_instruction()

int is_instruction

(

const char *

s

)

Check if the given string is an instruction.

Parameters

s	the string to check

Returns

instruction enumerator if true, -1 if false

is_label()

int is_label	(	const char *	s,
		label_list_t *	labels
	)

Check if given string is a label reference.

Parameters

s	string to check
labels	label list to check from

Returns

label index if true, -1 otherwise

is_label_definition()

int is_label_definition

(

const char *

s

)

Check if the given string is a label definition.

Parameters

s	the string to check

Returns

1 if true, 0 if false

is_register()

int is_register

(

const char *

s

)

Check if the given string represents a V register.

Parameters

s	string to check

Returns

V register number if true, -1 otherwise

is_reserved_identifier()

int is_reserved_identifier

(

const char *

s

)

Check if given string is a reserved identifier.

Parameters

s	string to check

Returns

type of identifier if true, -1 otherwise

next_symbol()

symbol_t * next_symbol

(

symbol_list_t *

symbols

)

Get the next symbol.

Returns

first empty symbol in symbol table

populate_labels()

int populate_labels	(	char **	lines,
		int	lineCount,
		label_list_t *	labels
	)

Populate label list from lines.

Parameters

lines	lines to search
lineCount	number of lines to search
labels	label list to populate

Returns

1 if success, 0 if failure

resolve_labels()

int resolve_labels	(	symbol_list_t *	symbols,
		label_list_t *	labels
	)

Get byte indexes of label definitions from completed symbol table.

Parameters

symbols	list of symbols
labels	list of labels

Returns

1 if success, 0 if failure

substitute_labels()

int substitute_labels	(	symbol_list_t *	symbols,
		label_list_t *	labels
	)

Substitute label symbols with their corresponding int value.

Parameters

symbols	symbols to search
labels	labels to search

Variable Documentation

c8_identifierStrings

const char* c8_identifierStrings[]

Initial value:

= {
    "",
    S_DT,
    S_ST,
    S_I,
    S_IP,
    S_K,
    S_F,
    S_B,
    S_DB,
    S_DW,
    S_DS,
    S_HF,
    S_R,
    NULL,
}

Reserved identifier strings. Has to match Symbol.

c8_instructionStrings

const char* c8_instructionStrings[]

Initial value:

= {
    S_CLS,
    S_RET,
    S_JP,
    S_CALL,
    S_SE,
    S_SNE,
    S_LD,
    S_ADD,
    S_OR,
    S_AND,
    S_SUB,
    S_SHR,
    S_SUBN,
    S_SHL,
    S_RND,
    S_DRW,
    S_SKP,
    S_SKNP,
    S_XOR,
    S_SCD,
    S_SCR,
    S_SCL,
    S_EXIT,
    S_LOW,
    S_HIGH,
    NULL,
}

Instruction strings. Has to match Instruction.

formats

instruction_format_t formats[]

All valid instruction formats