" SubX syntax file
" Language: SubX
" Maintainer: Kartik Agaram <mu@akkartik.com>
" URL: https://github.com/akkartik/mu
" License: public domain
"
" Copy this into your ftplugin directory, and add the following to your vimrc
" or to .vim/ftdetect/subx.vim:
" autocmd BufReadPost,BufNewFile *.subx set filetype=subx
let s:save_cpo = &cpo
set cpo&vim
" setlocal iskeyword=@,48-57,?,!,_,$,-
setlocal formatoptions-=t " allow long lines
setlocal formatoptions+=c " but comments should still wrap
setlocal iskeyword+=-,?
" blue tones
" comment colors for dark terminal: 14, 39, 27, 19
" comment colors for light terminal: 19, 27, 39, 6
"? syntax match subxH1Comment /# - .*/ | highlight subxH1Comment cterm=underline ctermfg=27
"? syntax match subxComment /#[^ ].*\|# [^.-].*\|# \?$/ | highlight subxComment ctermfg=27
"? syntax match subxS1Comment /# \..*/ | highlight subxS1Comment ctermfg=19
"? syntax match subxS2Comment /# \. \..*/ | highlight subxS2Comment ctermfg=245
" blue-green tones
syntax match subxH1Comment /# - .*/ | highlight subxH1Comment cterm=underline ctermfg=25
syntax match subxComment /#\( \.\| - \|? \)\@!.*/ | highlight subxComment ctermfg=25
syntax match subxS1Comment /# \..*/ | highlight subxS1Comment ctermfg=19
syntax match subxS2Comment /# \. \..*/ | highlight subxS2Comment ctermfg=245
" grey tones
"? syntax match subxH1Comment /# - .*/ | highlight subxH1Comment cterm=bold,underline
"? syntax match subxComment /#[^ ].*\|# [^.-].*\|# \?$/ | highlight subxComment cterm=bold ctermfg=236
"? hi Normal ctermfg=236
"? syntax match subxS1Comment /# \..*/ | highlight subxS1Comment cterm=bold ctermfg=242
"? syntax match subxS2Comment /# \. \..*/ | highlight subxS2Comment ctermfg=242
set comments-=:#
set comments+=n:#
syntax match subxCommentedCode "#? .*" | highlight link subxCommentedCode CommentedCode
let b:cmt_head = "#? "
" comment token
syntax match subxDelimiter / \. / | highlight link subxDelimiter Normal
syntax match subxString %"[^"]*"% | highlight link subxString Constant
"" definitions
" match globals but not registers like 'EAX'
" don't match capitalized words in metadata
" don't match inside strings
syntax match subxGlobal %\(/\)\@<!\<[A-Z][a-z0-9_-]*\>% | highlight link subxGlobal SpecialChar
" tweak the red color from the colorscheme just a tad to improve contrast
highlight SpecialChar ctermfg=160
" functions but not tests, globals or internal functions
syntax match subxFunction "^\(test_\)\@<![a-z][^ ]*\(:\)\@=" | highlight subxFunction cterm=underline ctermfg=130
" tests starting with 'test-'; dark:34 light:64
syntax match subxTest "^test-[^ ]*\(:\)\@=" | highlight subxTest ctermfg=64
pre { line-height: 125%; }
td.linenos .normal { color: inherit; background-color: transparent; padding-left: 5px; padding-right: 5px; }
span.linenos { color: inherit; background-color: transparent; padding-left: 5px; padding-right: 5px; }
td.linenos .special { color: #000000; background-color: #ffffc0; padding-left: 5px; padding-right: 5px; }
span.linenos.special { color: #000000; background-color: #ffffc0; padding-left: 5px; padding-right: 5px; }
.highlight .hll { background-color: #ffffcc }
.highlight .c { color: #888888 } /* Comment */
.highlight .err { color: #a61717; background-color: #e3d2d2 } /* Error */
.highlight .k { color: #008800; font-weight: bold } /* Keyword */
.highlight .ch { color: #888888 } /* Comment.Hashbang */
.highlight .cm { color: #888888 } /* Comment.Multiline */
.highlight .cp { color: #cc0000; font-weight: bold } /* Comment.Preproc */
.highlight .cpf { color: #888888 } /* Comment.PreprocFile */
.highlight .c1 { color: #888888 } /* Comment.Single */
.highlight .cs { color: #cc0000; font-weight: bold; background-color: #fff0f0 } /* Comment.Special */
.highlight .gd { color: #000000; background-color: #ffdddd } /* Generic.Deleted */
.highlight .ge { font-style: italic } /* Generic.Emph */
.highlight .ges { font-weight: bold; font-style: italic } /* Generic.EmphStrong */
.highlight .gr { color: #aa0000 } /* Generic.Error */
.highlight .gh { color: #333333 } /* Generic.Heading */
.highlight .gi { color: #000000; background-color: #ddffdd } /* Generic.Inserted */
.highlight .go { color: #888888 } /* Generic.Output */
.highlight .gp { color: #555555 } /* Generic.Prompt */
.highlight .gs { font-weight: bold } /* Generic.Strong */
.highlight .gu { color: #666666 } /* Generic.Subheading */
.highlight .gt { color: #aa0000 } /* Generic.Traceback */
.highlight .kc { color: #008800; font-weight: bold } /* Keyword.Constant */
.highlight .kd { color: #008800; font-weight: bold } /* Keyword.Declaration */
.highlight .kn { color: #008800; font-weight: bold } /* Keyword.Namespace */
.highlight .kp { color: #008800 } /* Keyword.Pseudo */
.highlight .kr { color: #008800; font-weight: bold } /* Keyword.Reserved */
.highlight .kt { color: #888888; font-weight: bold } /* Keyword.Type */
.highlight .m { color: #0000DD; font-weight: bold } /* Literal.Number */
.highlight .s { color: #dd2200; background-color: #fff0f0 } /* Literal.String */
.highlight .na { color: #336699 } /* Name.Attribute */
.highlight .nb { color: #003388 } /* Name.Builtin */
.highlight .nc { color: #bb0066; font-weight: bold } /* Name.Class */
.highlight .no { color: #003366; font-weight: bold } /* Name.Constant */
.highlight .nd { color: #555555 } /* Name.Decorator */
.highlight .ne { color: #bb0066; font-weight: bold } /* Name.Exception */
.highlight .nf { color: #0066bb; font-weight: bold } /* Name.Function */
.highlight .nl { color: #336699; font-style: italic } /* Name.Label */
.highlight .nn { color: #bb0066; font-weight: bold } /* Name.Namespace */
.highlight .py { color: #336699; font-weight: bold } /* Name.Property */
.highlight .nt { color: #bb0066; font-weight: bold } /* Name.Tag */
.highlight .nv { color: #336699 } /* Name.Variable */
.highlight .ow { color: #008800 } /* Operator.Word */
.highlight .w { color: #bbbbbb } /* Text.Whitespace */
.highlight .mb { color: #0000DD; font-weight: bold } /* Literal.Number.Bin */
.highlight .mf { color: #0000DD; font-weight: bold } /* Literal.Number.Float */
.highlight .mh { color: #0000DD; font-weight: bold } /* Literal.Number.Hex */
.highlight .mi { color: #0000DD; font-weight: bold } /* Literal.Number.Integer */
.highlight .mo { color: #0000DD; font-weight: bold } /* Literal.Number.Oct */
.highlight .sa { color: #dd2200; background-color: #fff0f0 } /* Literal.String.Affix */
.highlight .sb { color: #dd2200; background-color: #fff0f0 } /* Literal.String.Backtick */
.highlight .sc { color: #dd2200; background-color: #fff0f0 } /* Literal.String.Char */
.highlight .dl { color: #dd2200; background-color: #fff0f0 } /* Literal.String.Delimiter */
.highlight .sd { color: #dd2200; background-color: #fff0f0 } /* Literal.String.Doc */
.highlight .s2 { color: #dd2200; background-color: #fff0f0 } /* Literal.String.Double */
.highlight .se { color: #0044dd; background-color: #fff0f0 } /* Literal.String.Escape */
.highlight .sh { color: #dd2200; background-color: #fff0f0 } /* Literal.String.Heredoc */
.highlight .si { color: #3333bb; background-color: #fff0f0 } /* Literal.String.Interpol */
.highlight .sx { color: #22bb22; background-color: #f0fff0 } /* Literal.String.Other */
.highlight .sr { color: #008800; background-color: #fff0ff } /* Literal.String.Regex */
.highlight .s1 { color: #dd2200; background-color: #fff0f0 } /* Literal.String.Single */
.highlight .ss { color: #aa6600; background-color: #fff0f0 } /* Literal.String.Symbol */
.highlight .bp { color: #003388 } /* Name.Builtin.Pseudo */
.highlight .fm { color: #0066bb; font-weight: bold } /* Name.Function.Magic */
.highlight .vc { color: #336699 } /* Name.Variable.Class */
.highlight .vg { color: #dd7700 } /* Name.Variable.Global */
.highlight .vi { color: #3333bb } /* Name.Variable.Instance */
.highlight .vm { color: #336699 } /* Name.Variable.Magic */
.highlight .il { color: #0000DD; font-weight: bold } /* Literal.Number.Integer.Long *///: Clean syntax to manipulate and check the screen in scenarios.
//: Instructions 'assume-screen' and 'screen-should-contain' implicitly create
//: a variable called 'screen' that is accessible to later instructions in the
//: scenario. 'screen-should-contain' can check unicode characters in the fake
//: screen
//: first make sure we don't mangle these functions in other transforms
:(before "End initialize_transform_rewrite_literal_string_to_text()")
recipes_taking_literal_strings.insert("screen-should-contain");
recipes_taking_literal_strings.insert("screen-should-contain-in-color");
:(scenarios run_mu_scenario)
:(scenario screen_in_scenario)
scenario screen-in-scenario [
local-scope
assume-screen 5/width, 3/height
run [
a:char <- copy 97/a
screen:&:screen <- print screen:&:screen, a
]
screen-should-contain [
# 01234
.a .
. .
. .
]
]
# checks are inside scenario
:(scenario screen_in_scenario_unicode)
# screen-should-contain can check unicode characters in the fake screen
scenario screen-in-scenario-unicode [
local-scope
assume-screen 5/width, 3/height
run [
lambda:char <- copy 955/greek-small-lambda
screen:&:screen <- print screen:&:screen, lambda
a:char <- copy 97/a
screen:&:screen <- print screen:&:screen, a
]
screen-should-contain [
# 01234
.λa .
. .
. .
]
]
# checks are inside scenario
:(scenario screen_in_scenario_color)
scenario screen-in-scenario-color [
local-scope
assume-screen 5/width, 3/height
run [
lambda:char <- copy 955/greek-small-lambda
screen:&:screen <- print screen:&:screen, lambda, 1/red
a:char <- copy 97/a
screen:&:screen <- print screen:&:screen, a, 7/white
]
# screen-should-contain shows everything
screen-should-contain [
# 01234
.λa .
. .
. .
]
# screen-should-contain-in-color filters out everything except the given
# color, all you see is the 'a' in white.
screen-should-contain-in-color 7/white, [
# 01234
. a .
. .
. .
]
# ..and the λ in red.
screen-should-contain-in-color 1/red, [
# 01234
.λ .
. .
. .
]
]
# checks are inside scenario
:(scenario screen_in_scenario_error)
% Scenario_testing_scenario = true;
% Hide_errors = true;
scenario screen-in-scenario-error [
local-scope
assume-screen 5/width, 3/height
run [
a:char <- copy 97/a
screen:&:screen <- print screen:&:screen, a
]
screen-should-contain [
# 01234
.b .
. .
. .
]
]
+error: F - screen-in-scenario-error: expected screen location (0, 0) to contain 98 ('b') instead of 97 ('a')
:(scenario screen_in_scenario_color_error)
% Scenario_testing_scenario = true;
% Hide_errors = true;
# screen-should-contain can check unicode characters in the fake screen
scenario screen-in-scenario-color-error [
local-scope
assume-screen 5/width, 3/height
run [
a:char <- copy 97/a
screen:&:screen <- print screen:&:screen, a, 1/red
]
screen-should-contain-in-color 2/green, [
# 01234
.a .
. .
. .
]
]
+error: F - screen-in-scenario-color-error: expected screen location (0, 0) to contain 'a' in color 2 instead of 1
:(scenarios run)
:(scenario convert_names_does_not_fail_when_mixing_special_names_and_numeric_locations)
% Scenario_testing_scenario = true;
def main [
screen:num <- copy 1:num
]
-error: mixing variable names and numeric addresses in main
$error: 0
:(scenarios run_mu_scenario)
//: It's easier to implement assume-screen and other similar scenario-only
//: primitives if they always write to a fixed location. So we'll assign a
//: single fixed location for the per-scenario screen, keyboard, file system,
//: etc. Carve space for these fixed locations out of the reserved-for-test
//: locations.
:(before "End Globals")
extern const int Max_variables_in_scenarios = Reserved_for_tests-100;
int Next_predefined_global_for_scenarios = Max_variables_in_scenarios;
:(before "End Reset")
assert(Next_predefined_global_for_scenarios < Reserved_for_tests);
:(before "End Globals")
// Scenario Globals.
extern const int SCREEN = Next_predefined_global_for_scenarios++;
// End Scenario Globals.
//: give 'screen' a fixed location in scenarios
:(before "End Special Scenario Variable Names(r)")
Name[r]["screen"] = SCREEN;
//: make 'screen' always a raw location in scenarios
:(before "End is_special_name Special-cases")
if (s == "screen") return true;
:(before "End Rewrite Instruction(curr, recipe result)")
// rewrite 'assume-screen width, height' to
// 'screen:&:screen <- new-fake-screen width, height'
if (curr.name == "assume-screen") {
curr.name = "new-fake-screen";
if (!curr.products.empty()) {
raise << result.name << ": 'assume-screen' has no products\n" << end();
}
else if (!starts_with(result.name, "scenario_")) {
raise << result.name << ": 'assume-screen' can't be called here, only in scenarios\n" << end();
}
else {
assert(curr.products.empty());
curr.products.push_back(reagent("screen:&:screen/raw"));
curr.products.at(0).set_value(SCREEN);
}
}
:(scenario assume_screen_shows_up_in_errors)
% Hide_errors = true;
scenario assume-screen-shows-up-in-errors [
assume-screen width, 5
]
+error: assume-screen-shows-up-in-errors: missing type for 'width' in 'assume-screen width, 5'
//: screen-should-contain is a regular instruction
:(before "End Primitive Recipe Declarations")
SCREEN_SHOULD_CONTAIN,
:(before "End Primitive Recipe Numbers")
put(Recipe_ordinal, "screen-should-contain", SCREEN_SHOULD_CONTAIN);
:(before "End Primitive Recipe Checks")
case SCREEN_SHOULD_CONTAIN: {
if (SIZE(inst.ingredients) != 1) {
raise << maybe(get(Recipe, r).name) << "'screen-should-contain' requires exactly one ingredient, but got '" << to_original_string(inst) << "'\n" << end();
break;
}
if (!is_literal_text(inst.ingredients.at(0))) {
raise << maybe(get(Recipe, r).name) << "first ingredient of 'screen-should-contain' should be a literal string, but got '" << inst.ingredients.at(0).original_string << "'\n" << end();
break;
}
break;
}
:(before "End Primitive Recipe Implementations")
case SCREEN_SHOULD_CONTAIN: {
if (!Passed) break;
assert(scalar(ingredients.at(0)));
check_screen(current_instruction().ingredients.at(0).name, -1);
break;
}
:(before "End Primitive Recipe Declarations")
SCREEN_SHOULD_CONTAIN_IN_COLOR,
:(before "End Primitive Recipe Numbers")
put(Recipe_ordinal, "screen-should-contain-in-color", SCREEN_SHOULD_CONTAIN_IN_COLOR);
:(before "End Primitive Recipe Checks")
case SCREEN_SHOULD_CONTAIN_IN_COLOR: {
if (SIZE(inst.ingredients) != 2) {
raise << maybe(get(Recipe, r).name) << "'screen-should-contain-in-color' requires exactly two ingredients, but got '" << to_original_string(inst) << "'\n" << end();
break;
}
if (!is_mu_number(inst.ingredients.at(0))) {
raise << maybe(get(Recipe, r).name) << "first ingredient of 'screen-should-contain-in-color' should be a number (color code), but got '" << inst.ingredients.at(0).original_string << "'\n" << end();
break;
}
if (!is_literal_text(inst.ingredients.at(1))) {
raise << maybe(get(Recipe, r).name) << "second ingredient of 'screen-should-contain-in-color' should be a literal string, but got '" << inst.ingredients.at(1).original_string << "'\n" << end();
break;
}
break;
}
:(before "End Primitive Recipe Implementations")
case SCREEN_SHOULD_CONTAIN_IN_COLOR: {
if (!Passed) break;
assert(scalar(ingredients.at(0)));
assert(scalar(ingredients.at(1)));
check_screen(current_instruction().ingredients.at(1).name, ingredients.at(0).at(0));
break;
}
:(before "End Types")
// scan an array of characters in a unicode-aware, bounds-checked manner
struct raw_string_stream {
int index;
const int max;
const char* buf;
raw_string_stream(const string&);
uint32_t get(); // unicode codepoint
uint32_t peek(); // unicode codepoint
bool at_end() const;
void skip_whitespace_and_comments();
};
:(code)
void check_screen(const string& expected_contents, const int color) {
int screen_location = get_or_insert(Memory, SCREEN)+/*skip refcount*/1;
int data_offset = find_element_name(get(Type_ordinal, "screen"), "data", "");
assert(data_offset >= 0);
int screen_data_location = screen_location+data_offset; // type: address:array:character
int screen_data_start = get_or_insert(Memory, screen_data_location) + /*skip refcount*/1; // type: array:character
int width_offset = find_element_name(get(Type_ordinal, "screen"), "num-columns", "");
int screen_width = get_or_insert(Memory, screen_location+width_offset);
int height_offset = find_element_name(get(Type_ordinal, "screen"), "num-rows", "");
int screen_height = get_or_insert(Memory, screen_location+height_offset);
raw_string_stream cursor(expected_contents);
// todo: too-long expected_contents should fail
int top_index_offset = find_element_name(get(Type_ordinal, "screen"), "top-idx", "");
int top_index = get_or_insert(Memory, screen_location+top_index_offset);
for (int i=0, row=top_index/screen_width; i < screen_height; ++i, row=(row+1)%screen_height) {
cursor.skip_whitespace_and_comments();
if (cursor.at_end()) break;
if (cursor.get() != '.') {
raise << maybe(current_recipe_name()) << "each row of the expected screen should start with a '.'\n" << end();
if (!Scenario_testing_scenario) Passed = false;
return;
}
int addr = screen_data_start+/*length*/1+row*screen_width* /*size of screen-cell*/2;
for (int column = 0; column < screen_width; ++column, addr+= /*size of screen-cell*/2) {
const int cell_color_offset = 1;
uint32_t curr = cursor.get();
if (get_or_insert(Memory, addr) == 0 && isspace(curr)) continue;
if (curr == ' ' && color != -1 && color != get_or_insert(Memory, addr+cell_color_offset)) {
// filter out other colors
continue;
}
if (get_or_insert(Memory, addr) != 0 && get_or_insert(Memory, addr) == curr) {
if (color == -1 || color == get_or_insert(Memory, addr+cell_color_offset)) continue;
// contents match but color is off
if (!Hide_errors) cerr << '\n';
raise << "F - " << maybe(current_recipe_name()) << "expected screen location (" << row << ", " << column << ") to contain '" << unicode_character_at(addr) << "' in color " << color << " instead of " << no_scientific(get_or_insert(Memory, addr+cell_color_offset)) << "\n" << end();
if (!Hide_errors) dump_screen();
if (!Scenario_testing_scenario) Passed = false;
return;
}
// really a mismatch
// can't print multi-byte unicode characters in errors just yet. not very useful for debugging anyway.
char expected_pretty[10] = {0};
if (curr < 256 && !iscntrl(curr)) {
// " ('<curr>')"
expected_pretty[0] = ' ', expected_pretty[1] = '(', expected_pretty[2] = '\'', expected_pretty[3] = static_cast<unsigned char>(curr), expected_pretty[4] = '\'', expected_pretty[5] = ')', expected_pretty[6] = '\0';
}
char actual_pretty[10] = {0};
if (get_or_insert(Memory, addr) < 256 && !iscntrl(get_or_insert(Memory, addr))) {
// " ('<curr>')"
actual_pretty[0] = ' ', actual_pretty[1] = '(', actual_pretty[2] = '\'', actual_pretty[3] = static_cast<unsigned char>(get_or_insert(Memory, addr)), actual_pretty[4] = '\'', actual_pretty[5] = ')', actual_pretty[6] = '\0';
}
ostringstream color_phrase;
if (color != -1) color_phrase << " in color " << color;
if (!Hide_errors) cerr << '\n';
raise << "F - " << maybe(current_recipe_name()) << "expected screen location (" << row << ", " << column << ") to contain " << curr << expected_pretty << color_phrase.str() << " instead of " << no_scientific(get_or_insert(Memory, addr)) << actual_pretty << '\n' << end();
if (!Hide_errors) dump_screen();
if (!Scenario_testing_scenario) Passed = false;
return;
}
if (cursor.get() != '.') {
raise << maybe(current_recipe_name()) << "row " << row << " of the expected screen is too long\n" << end();
if (!Scenario_testing_scenario) Passed = false;
return;
}
}
cursor.skip_whitespace_and_comments();
if (!cursor.at_end()) {
raise << maybe(current_recipe_name()) << "expected screen has too many rows\n" << end();
Passed = false;
}
}
const char* unicode_character_at(int addr) {
int unicode_code_point = static_cast<int>(get_or_insert(Memory, addr));
return to_unicode(unicode_code_point);
}
raw_string_stream::raw_string_stream(const string& backing) :index(0), max(SIZE(backing)), buf(backing.c_str()) {}
bool raw_string_stream::at_end() const {
if (index >= max) return true;
if (tb_utf8_char_length(buf[index]) > max-index) {
raise << "unicode string seems corrupted at index "<< index << " character " << static_cast<int>(buf[index]) << '\n' << end();
return true;
}
return false;
}
uint32_t raw_string_stream::get() {
assert(index < max); // caller must check bounds before calling 'get'
uint32_t result = 0;
int length = tb_utf8_char_to_unicode(&result, &buf[index]);
assert(length != TB_EOF);
index += length;
return result;
}
uint32_t raw_string_stream::peek() {
assert(index < max); // caller must check bounds before calling 'get'
uint32_t result = 0;
int length = tb_utf8_char_to_unicode(&result, &buf[index]);
assert(length != TB_EOF);
return result;
}
void raw_string_stream::skip_whitespace_and_comments() {
while (!at_end()) {
if (isspace(peek())) get();
else if (peek() == '#') {
// skip comment
get();
while (peek() != '\n') get(); // implicitly also handles CRLF
}
else break;
}
}
:(before "End Primitive Recipe Declarations")
_DUMP_SCREEN,
:(before "End Primitive Recipe Numbers")
put(Recipe_ordinal, "$dump-screen", _DUMP_SCREEN);
:(before "End Primitive Recipe Checks")
case _DUMP_SCREEN: {
break;
}
:(before "End Primitive Recipe Implementations")
case _DUMP_SCREEN: {
dump_screen();
break;
}
:(code)
void dump_screen() {
int screen_location = get_or_insert(Memory, SCREEN) + /*skip refcount*/1;
int width_offset = find_element_name(get(Type_ordinal, "screen"), "num-columns", "");
int screen_width = get_or_insert(Memory, screen_location+width_offset);
int height_offset = find_element_name(get(Type_ordinal, "screen"), "num-rows", "");
int screen_height = get_or_insert(Memory, screen_location+height_offset);
int data_offset = find_element_name(get(Type_ordinal, "screen"), "data", "");
assert(data_offset >= 0);
int screen_data_location = screen_location+data_offset; // type: address:array:character
int screen_data_start = get_or_insert(Memory, screen_data_location) + /*skip refcount*/1; // type: array:character
assert(get_or_insert(Memory, screen_data_start) == screen_width*screen_height);
int top_index_offset = find_element_name(get(Type_ordinal, "screen"), "top-idx", "");
int top_index = get_or_insert(Memory, screen_location+top_index_offset);
for (int i=0, row=top_index/screen_width; i < screen_height; ++i, row=(row+1)%screen_height) {
cerr << '.';
int curr = screen_data_start+/*length*/1+row*screen_width* /*size of screen-cell*/2;
for (int col = 0; col < screen_width; ++col) {
if (get_or_insert(Memory, curr))
cerr << to_unicode(static_cast<uint32_t>(get_or_insert(Memory, curr)));
else
cerr << ' ';
curr += /*size of screen-cell*/2;
}
cerr << ".\n";
}
}