Skip to content

Commit

Permalink
Merge pull request #468 from ogamespec/main
Browse files Browse the repository at this point in the history 
Breakasm INCLUDE support
  • Loading branch information
@ogamespec
ogamespec authored Sep 7, 2023
2 parents 896167f + a81ac08 commit 911be98
Show file tree
Hide file tree
Showing 8 changed files with 193 additions and 47 deletions.
117 changes: 99 additions & 18 deletions Tools/Breakasm/ASM.cpp
View file
Original file line number Diff line number Diff line change
Expand Up @@ -19,16 +19,41 @@

static uint8_t *PRG;
long org; // current emit offset
int linenum;
long stop;
long errors;

static std::list<label_s *> labels; // name labels
static std::list<patch_s *> patchs; // patch history
static std::list<define_s *> defines; // definitions

static std::list<std::string> source_name_stack; // Stack for the name of the current source file (for INCLUDE)
static std::list<int> linenum_stack; // Stack for the line number of the current source file (for INCLUDE)

// ****************************************************************

/// <summary>
/// The linenum stack is required to support INCLUDE. Where previously just the linenum variable was used, this call is now used.
/// </summary>
/// <returns>Line number where the assembler is currently located in the current source file</returns>
int get_linenum()
{
return linenum_stack.back();
}

void nextline()
{
linenum_stack.back()++;
}

/// <summary>
/// Get the name of the current source file currently being worked with.
/// </summary>
/// <returns></returns>
std::string get_source_name()
{
return source_name_stack.back();
}

// Labels management.
//

Expand Down Expand Up @@ -58,22 +83,24 @@ label_s *add_label (const char *name, long orig)
label = new label_s;
strcpy (label->name, temp_name);
label->orig = orig;
label->line = linenum;
strcpy(label->source, get_source_name().c_str());
label->line = get_linenum();
labels.push_back(label);
}
else {
if ( label->orig == KEYWORD ) {
printf ("ERROR(%i): Reserved keyword used as label \'%s\'\n", linenum, temp_name);
printf ("ERROR(%s,%i): Reserved keyword used as label \'%s\'\n", get_source_name().c_str(), get_linenum(), temp_name);
errors++;
}
else if (orig != UNDEF && label->orig != UNDEF ) {
printf ("ERROR(%i): label \'%s\' already defined in line %i\n", linenum, temp_name, label->line);
printf ("ERROR(%s,%i): label \'%s\' already defined in %s, line %i\n", get_source_name().c_str(), get_linenum(), temp_name, label->source, label->line);
errors++;
}
else {
if (orig != UNDEF) {
label->orig = orig;
label->line = linenum;
strcpy(label->source, get_source_name().c_str());
label->line = get_linenum();
}
}
}
Expand All @@ -85,7 +112,7 @@ static void dump_labels (void)
int i = 0;
label_s * label;
printf ("\nLABELS (%d):\n", (int)labels.size());
for (auto it = labels.begin(); it != labels.end(); ++i) {
for (auto it = labels.begin(); it != labels.end(); ++it) {
label = *it;
if (label->orig == KEYWORD) continue;
printf("%i: $%08X = \'%s\'\n", i + 1, label->orig, label->name);
Expand All @@ -96,13 +123,14 @@ static void dump_labels (void)
// Patch management.
//

void add_patch (label_s *label, long orig, int branch, int line)
void add_patch (label_s *label, long orig, int branch)
{
patch_s * patch = new patch_s;
patch->label = label;
patch->orig = orig;
patch->branch = branch;
patch->line = line;
strcpy(patch->source, get_source_name().c_str());
patch->line = get_linenum();
patchs.push_back(patch);
}

Expand All @@ -115,15 +143,15 @@ static void do_patch (void)
patch = *it;
orig = patch->label->orig;
if ( orig == UNDEF ) {
printf ("ERROR(%i): Undefined label \'%s\' (%08X)\n", patch->line, patch->label->name, orig );
printf ("ERROR(%s,%i): Undefined label \'%s\' (%08X)\n", patch->source, patch->line, patch->label->name, orig );
errors++;
}
else {
if ( patch->branch != 0) {
org = patch->orig;
rel = orig - org - 1;
if (rel > 127 || rel < -128) {
printf("ERROR(%i): Branch relative offset to %s out of range\n", patch->line, patch->label->name);
printf("ERROR(%s,%i): Branch relative offset to %s out of range\n", patch->source, patch->line, patch->label->name);
errors++;
}
else emit(rel & 0xff);
Expand All @@ -143,7 +171,7 @@ static void dump_patches (void)
printf ("\nPATCHS (%d):\n", (int)patchs.size());
for (auto it = patchs.begin(); it != patchs.end(); ++it) {
patch = *it;
printf("LINE %i: $%08X = \'%s\'", patch->line, patch->orig, patch->label->name);
printf("%s, line %i: $%08X = \'%s\'", patch->source, patch->line, patch->orig, patch->label->name);
if (patch->branch) printf(" (REL)\n");
else printf(" (ABS)\n");
}
Expand All @@ -168,7 +196,7 @@ define_s *add_define (char *name, char *replace)
define_s * def;

if ( label = label_lookup (name) ) {
printf ("ERROR(%i): Already defined as label in line %i\n", linenum, label->line );
printf ("ERROR(%s,%i): Already defined as label in %s, line %i\n", get_source_name().c_str(), get_linenum(), label->source, label->line );
errors++;
return NULL;
}
Expand Down Expand Up @@ -201,7 +229,7 @@ static void dump_defines (void)
// ****************************************************************
// Evaluate expression

// Evaluation code can be replaced by more complicated version (with macro-operations etc.)
// TODO: Evaluation code will be replaced by more complicated version (with macro-operations etc.)

int eval (char *text, eval_t *result)
{
Expand Down Expand Up @@ -479,6 +507,7 @@ static oplink optab[] = {
{ "STY", opLDSTY },

// Directives
{ "INCLUDE", opINCLUDE },
{ "DEFINE", opDEFINE },
{ "BYTE", opBYTE },
{ "WORD", opWORD },
Expand All @@ -505,14 +534,15 @@ static void cleanup (void)
delete item;
}

// Clear defines
while (!defines.empty()) {
define_s* item = defines.back();
defines.pop_back();
delete item;
}
}

int assemble (char *text, uint8_t *prg)
int assemble (char *text, char* source_name, uint8_t *prg)
{
line l;
oplink *opl;
Expand All @@ -523,8 +553,10 @@ int assemble (char *text, uint8_t *prg)

cleanup ();

source_name_stack.push_back(source_name);

// Add keywords
linenum = 0;
linenum_stack.push_back(0);
add_label ("A", KEYWORD);
add_label ("X", KEYWORD);
add_label ("Y", KEYWORD);
Expand All @@ -534,7 +566,7 @@ int assemble (char *text, uint8_t *prg)
else add_label (opl->name, KEYWORD);
opl++;
}
linenum++;
nextline();

while (1) {
if (*text == 0) break;
Expand All @@ -552,7 +584,7 @@ int assemble (char *text, uint8_t *prg)
opl = optab;
while (1) {
if ( opl->name == NULL ) {
printf ("ERROR(%i): Unknown command %s\n", linenum, l.cmd);
printf ("ERROR(%s,%i): Unknown command %s\n", get_source_name().c_str(), get_linenum(), l.cmd);
break;
}
else if ( !_stricmp (opl->name, l.cmd) ) {
Expand All @@ -564,7 +596,7 @@ int assemble (char *text, uint8_t *prg)
}
if (stop) break;
}
linenum++;
nextline();
}

// Patch jump/branch offsets.
Expand All @@ -579,3 +611,52 @@ int assemble (char *text, uint8_t *prg)
printf ( "%i error(s)\n", errors );
return errors;
}

/// <summary>
/// Assemble nested source file (called from the INCLUDE directive).
/// The name of the source file will be placed on the name stack, and the line counter will count from the beginning of the file.
/// </summary>
/// <param name="text">Source file text</param>
/// <param name="source_name">Source file name</param>
void assemble_include(char* text, char* source_name)
{
line l;
oplink* opl;

source_name_stack.push_back(source_name);
linenum_stack.push_back(1);

while (1) {
if (*text == 0) break;
parse_line(&text, l);

//printf ( "%s: \'%s\' \'%s\'\n", l.label, l.cmd, l.op );

// Add label
if (strlen(l.label) > 1) {
add_label(l.label, org);
}

// Execute command
if (strlen(l.cmd) > 1) {
opl = optab;
while (1) {
if (opl->name == NULL) {
printf("ERROR(%s,%i): Unknown command %s\n", get_source_name().c_str(), get_linenum(), l.cmd);
break;
}
else if (!_stricmp(opl->name, l.cmd)) {
_strupr(l.cmd);
opl->handler(l.cmd, l.op);
break;
}
opl++;
}
if (stop) break;
}
nextline();
}

source_name_stack.pop_back();
linenum_stack.pop_back();
}
13 changes: 9 additions & 4 deletions Tools/Breakasm/ASM.h
View file
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
#pragma once

#define BREAKASM_VERSION "1.2"
#define BREAKASM_VERSION "1.3"

#define UNDEF 0xbabadaba // undefined offset
#define KEYWORD 0xd0d0d0d0 // keyword
Expand All @@ -19,13 +19,15 @@ struct line {
struct label_s {
char name[128];
long orig;
char source[0x100];
int line;
};

struct patch_s {
label_s* label;
long orig;
int branch; // 1: relative branch, 0: absolute jmp
char source[0x100];
int line;
};

Expand Down Expand Up @@ -55,18 +57,21 @@ struct param_t {
};

extern long org; // current emit offset
extern int linenum;
extern long stop;
extern long errors;

extern param_t* params;
extern int param_num;

label_s* add_label(const char* name, long orig);
void add_patch(label_s* label, long orig, int branch, int line);
void add_patch(label_s* label, long orig, int branch);
define_s* add_define(char* name, char* replace);
int eval(char* text, eval_t* result);
void split_param(char* op);
void emit(uint8_t b);

int assemble (char *text, uint8_t *prg);
int get_linenum();
std::string get_source_name();

int assemble (char *text, char *source_name, uint8_t *prg);
void assemble_include(char* text, char* source_name);
Loading

0 comments on commit 911be98

Please sign in to comment.