2023-12-24 15:51:21 +00:00
<!DOCTYPE HTML>
< html lang = "en" class = "light" dir = "ltr" >
< head >
<!-- Book generated using mdBook -->
< meta charset = "UTF-8" >
< title > SymboScript book< / title >
< meta name = "robots" content = "noindex" >
<!-- Custom HTML head -->
< meta name = "description" content = "" >
< meta name = "viewport" content = "width=device-width, initial-scale=1" >
< meta name = "theme-color" content = "#ffffff" >
< link rel = "icon" href = "favicon.svg" >
< link rel = "shortcut icon" href = "favicon.png" >
< link rel = "stylesheet" href = "css/variables.css" >
< link rel = "stylesheet" href = "css/general.css" >
< link rel = "stylesheet" href = "css/chrome.css" >
< link rel = "stylesheet" href = "css/print.css" media = "print" >
<!-- Fonts -->
< link rel = "stylesheet" href = "FontAwesome/css/font-awesome.css" >
< link rel = "stylesheet" href = "fonts/fonts.css" >
<!-- Highlight.js Stylesheets -->
< link rel = "stylesheet" href = "highlight.css" >
< link rel = "stylesheet" href = "tomorrow-night.css" >
< link rel = "stylesheet" href = "ayu-highlight.css" >
<!-- Custom theme stylesheets -->
< / head >
< body class = "sidebar-visible no-js" >
< div id = "body-container" >
<!-- Provide site root to javascript -->
< script >
var path_to_root = "";
var default_theme = window.matchMedia("(prefers-color-scheme: dark)").matches ? "navy" : "light";
< / script >
<!-- Work around some values being stored in localStorage wrapped in quotes -->
< script >
try {
var theme = localStorage.getItem('mdbook-theme');
var sidebar = localStorage.getItem('mdbook-sidebar');
if (theme.startsWith('"') & & theme.endsWith('"')) {
localStorage.setItem('mdbook-theme', theme.slice(1, theme.length - 1));
}
if (sidebar.startsWith('"') & & sidebar.endsWith('"')) {
localStorage.setItem('mdbook-sidebar', sidebar.slice(1, sidebar.length - 1));
}
} catch (e) { }
< / script >
<!-- Set the theme before any content is loaded, prevents flash -->
< script >
var theme;
try { theme = localStorage.getItem('mdbook-theme'); } catch(e) { }
if (theme === null || theme === undefined) { theme = default_theme; }
var html = document.querySelector('html');
html.classList.remove('light')
html.classList.add(theme);
var body = document.querySelector('body');
body.classList.remove('no-js')
body.classList.add('js');
< / script >
< input type = "checkbox" id = "sidebar-toggle-anchor" class = "hidden" >
<!-- Hide / unhide sidebar before it is displayed -->
< script >
var body = document.querySelector('body');
var sidebar = null;
var sidebar_toggle = document.getElementById("sidebar-toggle-anchor");
if (document.body.clientWidth >= 1080) {
try { sidebar = localStorage.getItem('mdbook-sidebar'); } catch(e) { }
sidebar = sidebar || 'visible';
} else {
sidebar = 'hidden';
}
sidebar_toggle.checked = sidebar === 'visible';
body.classList.remove('sidebar-visible');
body.classList.add("sidebar-" + sidebar);
< / script >
< nav id = "sidebar" class = "sidebar" aria-label = "Table of contents" >
< div class = "sidebar-scrollbox" >
2023-12-26 10:07:34 +00:00
< ol class = "chapter" > < li class = "chapter-item expanded " > < a href = "specification/index.html" > < strong aria-hidden = "true" > 1.< / strong > Specification< / a > < / li > < li > < ol class = "section" > < li class = "chapter-item expanded " > < a href = "specification/tokens/index.html" > < strong aria-hidden = "true" > 1.1.< / strong > Tokens< / a > < / li > < li > < ol class = "section" > < li class = "chapter-item expanded " > < a href = "specification/tokens/token-format.html" > < strong aria-hidden = "true" > 1.1.1.< / strong > Token format< / a > < / li > < li class = "chapter-item expanded " > < a href = "specification/tokens/token-kinds.html" > < strong aria-hidden = "true" > 1.1.2.< / strong > Token Kinds< / a > < / li > < li > < ol class = "section" > < li class = "chapter-item expanded " > < a href = "specification/tokens/kinds/operators.html" > < strong aria-hidden = "true" > 1.1.2.1.< / strong > Operators< / a > < / li > < li class = "chapter-item expanded " > < a href = "specification/tokens/kinds/keywords.html" > < strong aria-hidden = "true" > 1.1.2.2.< / strong > Keywords< / a > < / li > < li class = "chapter-item expanded " > < a href = "specification/tokens/kinds/identifiers.html" > < strong aria-hidden = "true" > 1.1.2.3.< / strong > Identifiers< / a > < / li > < li class = "chapter-item expanded " > < a href = "specification/tokens/kinds/literals.html" > < strong aria-hidden = "true" > 1.1.2.4.< / strong > Literals< / a > < / li > < li class = "chapter-item expanded " > < a href = "specification/tokens/kinds/brackets.html" > < strong aria-hidden = "true" > 1.1.2.5.< / strong > Brackets< / a > < / li > < / ol > < / li > < / ol > < / li > < li class = "chapter-item expanded " > < a href = "specification/parser/index.html" > < strong aria-hidden = "true" > 1.2.< / strong > Parser< / a > < / li > < li class = "chapter-item expanded " > < a href = "examples/index.html" > < strong aria-hidden = "true" > 1.3.< / strong > Examples< / a > < / li > < / ol > < / li > < / ol >
2023-12-24 15:51:21 +00:00
< / div >
< div id = "sidebar-resize-handle" class = "sidebar-resize-handle" >
< div class = "sidebar-resize-indicator" > < / div >
< / div >
< / nav >
<!-- Track and set sidebar scroll position -->
< script >
var sidebarScrollbox = document.querySelector('#sidebar .sidebar-scrollbox');
sidebarScrollbox.addEventListener('click', function(e) {
if (e.target.tagName === 'A') {
sessionStorage.setItem('sidebar-scroll', sidebarScrollbox.scrollTop);
}
}, { passive: true });
var sidebarScrollTop = sessionStorage.getItem('sidebar-scroll');
sessionStorage.removeItem('sidebar-scroll');
if (sidebarScrollTop) {
// preserve sidebar scroll position when navigating via links within sidebar
sidebarScrollbox.scrollTop = sidebarScrollTop;
} else {
// scroll sidebar to current active section when navigating via "next/previous chapter" buttons
var activeSection = document.querySelector('#sidebar .active');
if (activeSection) {
activeSection.scrollIntoView({ block: 'center' });
}
}
< / script >
< div id = "page-wrapper" class = "page-wrapper" >
< div class = "page" >
< div id = "menu-bar-hover-placeholder" > < / div >
< div id = "menu-bar" class = "menu-bar sticky" >
< div class = "left-buttons" >
< label id = "sidebar-toggle" class = "icon-button" for = "sidebar-toggle-anchor" title = "Toggle Table of Contents" aria-label = "Toggle Table of Contents" aria-controls = "sidebar" >
< i class = "fa fa-bars" > < / i >
< / label >
< button id = "theme-toggle" class = "icon-button" type = "button" title = "Change theme" aria-label = "Change theme" aria-haspopup = "true" aria-expanded = "false" aria-controls = "theme-list" >
< i class = "fa fa-paint-brush" > < / i >
< / button >
< ul id = "theme-list" class = "theme-popup" aria-label = "Themes" role = "menu" >
< li role = "none" > < button role = "menuitem" class = "theme" id = "light" > Light< / button > < / li >
< li role = "none" > < button role = "menuitem" class = "theme" id = "rust" > Rust< / button > < / li >
< li role = "none" > < button role = "menuitem" class = "theme" id = "coal" > Coal< / button > < / li >
< li role = "none" > < button role = "menuitem" class = "theme" id = "navy" > Navy< / button > < / li >
< li role = "none" > < button role = "menuitem" class = "theme" id = "ayu" > Ayu< / button > < / li >
< / ul >
< button id = "search-toggle" class = "icon-button" type = "button" title = "Search. (Shortkey: s)" aria-label = "Toggle Searchbar" aria-expanded = "false" aria-keyshortcuts = "S" aria-controls = "searchbar" >
< i class = "fa fa-search" > < / i >
< / button >
< / div >
< h1 class = "menu-title" > SymboScript book< / h1 >
< div class = "right-buttons" >
< a href = "print.html" title = "Print this book" aria-label = "Print this book" >
< i id = "print-button" class = "fa fa-print" > < / i >
< / a >
< / div >
< / div >
< div id = "search-wrapper" class = "hidden" >
< form id = "searchbar-outer" class = "searchbar-outer" >
< input type = "search" id = "searchbar" name = "searchbar" placeholder = "Search this book ..." aria-controls = "searchresults-outer" aria-describedby = "searchresults-header" >
< / form >
< div id = "searchresults-outer" class = "searchresults-outer hidden" >
< div id = "searchresults-header" class = "searchresults-header" > < / div >
< ul id = "searchresults" >
< / ul >
< / div >
< / div >
<!-- Apply ARIA attributes after the sidebar and the sidebar toggle button are added to the DOM -->
< script >
document.getElementById('sidebar-toggle').setAttribute('aria-expanded', sidebar === 'visible');
document.getElementById('sidebar').setAttribute('aria-hidden', sidebar !== 'visible');
Array.from(document.querySelectorAll('#sidebar a')).forEach(function(link) {
link.setAttribute('tabIndex', sidebar === 'visible' ? 0 : -1);
});
< / script >
< div id = "content" class = "content" >
< main >
< h1 id = "specification" > < a class = "header" href = "#specification" > Specification< / a > < / h1 >
< div style = "break-before: page; page-break-before: always;" > < / div > < h1 id = "tokens" > < a class = "header" href = "#tokens" > Tokens< / a > < / h1 >
< p > This chapter describes the tokens specification. All of the tokens in the design are described in this section.< / p >
< div style = "break-before: page; page-break-before: always;" > < / div > < h1 id = "token-format" > < a class = "header" href = "#token-format" > Token format< / a > < / h1 >
< p > < a href = "https://github.com/SymboScript/SymboScript/blob/main/types/src/lexer.rs#L4-L15" > Token< / a > < / p >
< pre > < pre class = "playground" > < code class = "language-rust" > < span class = "boring" > #![allow(unused)]
< / span > < span class = "boring" > fn main() {
< / span > pub struct Token {
/// Token Type
pub kind: TokenKind,
/// Start offset in source
pub start: usize,
/// End offset in source
pub end: usize,
pub value: TokenValue,
}
< span class = "boring" > }< / span > < / code > < / pre > < / pre >
< p > < a href = "https://github.com/SymboScript/SymboScript/blob/main/types/src/lexer.rs#L110-L114" > TokenValue< / a > < / p >
< pre > < pre class = "playground" > < code class = "language-rust" > < span class = "boring" > #![allow(unused)]
< / span > < span class = "boring" > fn main() {
< / span > pub enum TokenValue {
None,
Number(f64),
String(String),
}
< span class = "boring" > }< / span > < / code > < / pre > < / pre >
< div style = "break-before: page; page-break-before: always;" > < / div > < h1 id = "token-kinds" > < a class = "header" href = "#token-kinds" > Token Kinds< / a > < / h1 >
< p > This chapter describes the token kinds used in the spec.< / p >
< p > < a href = "https://github.com/SymboScript/SymboScript/blob/main/types/src/lexer.rs#L18-L107" > Kinds< / a > < / p >
< pre > < pre class = "playground" > < code class = "language-rust" > < span class = "boring" > #![allow(unused)]
< / span > < span class = "boring" > fn main() {
< / span > pub enum TokenKind {
Eof, // end of file
Comment,
Unexpected,
Semicolon,
Comma,
Colon,
Dot,
// Operators
Plus,
Minus,
Star,
Slash,
Power,
Range,
Modulo,
// Bitwise operators (Keyword2Operator)
BitAnd,
BitOr,
BitNot,
BitXor,
BitLeftShift,
BitRightShift,
// Unary operators
PlusPlus,
MinusMinus,
Question,
// Logic operators (Keyword2Operator)
And,
Or,
Xor,
Not,
/// Assignments operators (+=, -=, *=, /=...)
Assign,
FormulaAssign,
PlusAssign,
MinusAssign,
MultiplyAssign,
DivideAssign,
PowerAssign,
ModuloAssign,
// Comparison operators
Equal,
NotEqual,
Less,
LessEqual,
Greater,
GreaterEqual,
// Brackets
LParen,
RParen,
LBrace,
RBrace,
LBracket,
RBracket,
// Identifiers
Identifier,
// Literals
Number,
Str,
// --- Keywords ---
// Keyword literals
True,
False,
// Keywords
If,
Else,
While,
For,
Loop,
Let,
Return,
Break,
Continue,
Function,
In,
}
< span class = "boring" > }< / span > < / code > < / pre > < / pre >
< div style = "break-before: page; page-break-before: always;" > < / div > < h1 id = "operators" > < a class = "header" href = "#operators" > Operators< / a > < / h1 >
< div style = "break-before: page; page-break-before: always;" > < / div > < h1 id = "keywords" > < a class = "header" href = "#keywords" > Keywords< / a > < / h1 >
< div style = "break-before: page; page-break-before: always;" > < / div > < h1 id = "identifiers" > < a class = "header" href = "#identifiers" > Identifiers< / a > < / h1 >
< div style = "break-before: page; page-break-before: always;" > < / div > < h1 id = "literals" > < a class = "header" href = "#literals" > Literals< / a > < / h1 >
< p > In SymboScript exists only three kinds of token literals: strings, numbers, booleans.< / p >
< h2 id = "strings" > < a class = "header" href = "#strings" > Strings< / a > < / h2 >
< p > Strings are enclosed in double quotes, single quotes or backticks.< / p >
2023-12-24 15:55:01 +00:00
< pre > < code class = "language-symboscript" > " hello"
" hello"
`hello`
" hello\nworld"
'hello" world'
" hello ' world"
2023-12-24 15:51:21 +00:00
< / code > < / pre >
< h2 id = "numbers" > < a class = "header" href = "#numbers" > Numbers< / a > < / h2 >
2023-12-24 15:55:01 +00:00
< pre > < code class = "language-symboscript" > 1 .1
2023-12-24 15:51:21 +00:00
1.1
1e1
1E1
1.1e1
1.1E1
< / code > < / pre >
< h2 id = "booleans" > < a class = "header" href = "#booleans" > Booleans< / a > < / h2 >
2023-12-24 15:55:01 +00:00
< pre > < code class = "language-symboscript" > true
false
2023-12-24 15:51:21 +00:00
< / code > < / pre >
< div style = "break-before: page; page-break-before: always;" > < / div > < h1 id = "brackets" > < a class = "header" href = "#brackets" > Brackets< / a > < / h1 >
2023-12-26 10:07:34 +00:00
< div style = "break-before: page; page-break-before: always;" > < / div > < h1 id = "parser" > < a class = "header" href = "#parser" > Parser< / a > < / h1 >
< h2 id = "expressionss" > < a class = "header" href = "#expressionss" > Expressionss< / a > < / h2 >
< h3 id = "operator-priority" > < a class = "header" href = "#operator-priority" > Operator priority< / a > < / h3 >
2023-12-26 10:30:39 +00:00
< div class = "table-wrapper" > < table > < thead > < tr > < th > Operator/Expression< / th > < th > Associativity< / th > < th > Parser fn name< / th > < th > Impl< / th > < / tr > < / thead > < tbody >
2023-12-31 08:46:26 +00:00
< tr > < td > Calls, Identifiers, Literals< / td > < td > Left to Right< / td > < td > call< / td > < td > ✅< / td > < / tr >
< tr > < td > Members< / td > < td > Left to Right< / td > < td > dot< / td > < td > ✅< / td > < / tr >
< tr > < td > new< / td > < td > Right to Left< / td > < td > new_expr< / td > < td > ✅< / td > < / tr >
< tr > < td > delete< / td > < td > Right to Left< / td > < td > delete_expr< / td > < td > ✅< / td > < / tr >
< tr > < td > await< / td > < td > Right to Left< / td > < td > await_expr< / td > < td > ✅< / td > < / tr >
< tr > < td > < code > !< / code > < code > ++< / code > < code > --< / code > < code > ()< / code > < code > ~< / code > (unary < code > -< / code > < code > +< / code > ) < code > []< / code > < code > {}< / code > < / td > < td > Left to Right< / td > < td > factor< / td > < td > ✅< / td > < / tr >
2023-12-26 10:30:39 +00:00
< tr > < td > < code > ^< / code > < / td > < td > Left to Left< / td > < td > power< / td > < td > ✅< / td > < / tr >
< tr > < td > < code > *< / code > < code > /< / code > < code > %< / code > < / td > < td > Left to Right< / td > < td > term< / td > < td > ✅< / td > < / tr >
< tr > < td > < code > +< / code > < code > -< / code > < / td > < td > Left to Right< / td > < td > add_sub< / td > < td > ✅< / td > < / tr >
2023-12-26 15:39:58 +00:00
< tr > < td > < code > > > < / code > < code > < < < / code > < / td > < td > Left to Right< / td > < td > shift< / td > < td > ✅< / td > < / tr >
< tr > < td > < code > & < / code > < / td > < td > Left to Right< / td > < td > bit_and< / td > < td > ✅< / td > < / tr >
< tr > < td > < code > bxor< / code > < / td > < td > Left to Right< / td > < td > bit_xor< / td > < td > ✅< / td > < / tr >
< tr > < td > < code > |< / code > < / td > < td > Left to Right< / td > < td > bit_or< / td > < td > ✅< / td > < / tr >
< tr > < td > < code > ==< / code > < code > !=< / code > < code > < < / code > < code > < =< / code > < code > > < / code > < code > > =< / code > < / td > < td > Left to Right< / td > < td > cmp< / td > < td > ✅< / td > < / tr >
< tr > < td > < code > & & < / code > < / td > < td > Left to Right< / td > < td > logical_and< / td > < td > ✅< / td > < / tr >
< tr > < td > < code > ||< / code > < / td > < td > Left to Right< / td > < td > logical_or< / td > < td > ✅< / td > < / tr >
< tr > < td > < code > ..< / code > < / td > < td > Left to Right< / td > < td > range< / td > < td > ✅< / td > < / tr >
2023-12-27 16:38:59 +00:00
< tr > < td > < code > ?:< / code > < / td > < td > Right to Left< / td > < td > ternary< / td > < td > ✅< / td > < / tr >
< tr > < td > < code > =< / code > < code > :=< / code > < code > +=< / code > < code > -=< / code > < code > *=< / code > < code > /=< / code > < code > ^=< / code > < code > %=< / code > < / td > < td > Right to Left< / td > < td > assign< / td > < td > ✅< / td > < / tr >
< tr > < td > < code > ,< / code > < / td > < td > None< / td > < td > comma< / td > < td > ✅< / td > < / tr >
2023-12-26 10:07:34 +00:00
< / tbody > < / table >
2023-12-31 08:46:26 +00:00
< / div >
< h3 id = "statements" > < a class = "header" href = "#statements" > Statements< / a > < / h3 >
< div class = "table-wrapper" > < table > < thead > < tr > < th > Statement< / th > < th > Parser fn name< / th > < th > Trigger token< / th > < th > Impl< / th > < / tr > < / thead > < tbody >
< tr > < td > Variable declaration< / td > < td > var_decl< / td > < td > Let< / td > < td > ✅< / td > < / tr >
2023-12-31 16:18:30 +00:00
< tr > < td > Async function declaration< / td > < td > fn_decl< / td > < td > Async< / td > < td > ✅< / td > < / tr >
2023-12-31 08:46:26 +00:00
< tr > < td > Function declaration< / td > < td > fn_decl< / td > < td > Function< / td > < td > ✅< / td > < / tr >
< tr > < td > Return statement< / td > < td > return_stmt< / td > < td > Return< / td > < td > ✅< / td > < / tr >
< tr > < td > Yield statement< / td > < td > yield_stmt< / td > < td > Yield< / td > < td > ✅< / td > < / tr >
< tr > < td > Break statement< / td > < td > break_stmt< / td > < td > Break< / td > < td > ✅< / td > < / tr >
< tr > < td > Continue statement< / td > < td > continue_stmt< / td > < td > Continue< / td > < td > ✅< / td > < / tr >
2023-12-31 10:52:34 +00:00
< tr > < td > If statement< / td > < td > if_stmt< / td > < td > If< / td > < td > ✅< / td > < / tr >
< tr > < td > While statement< / td > < td > while_stmt< / td > < td > While< / td > < td > ✅< / td > < / tr >
< tr > < td > For statement< / td > < td > for_stmt< / td > < td > For< / td > < td > ✅< / td > < / tr >
< tr > < td > Loop statement< / td > < td > loop_stmt< / td > < td > Loop< / td > < td > ✅< / td > < / tr >
2023-12-31 16:18:30 +00:00
< tr > < td > Try statement< / td > < td > try_stmt< / td > < td > Try< / td > < td > ✅< / td > < / tr >
< tr > < td > Throw statement< / td > < td > throw_stmt< / td > < td > Throw< / td > < td > ✅< / td > < / tr >
2023-12-31 08:46:26 +00:00
< tr > < td > Expression statement< / td > < td > expr_stmt< / td > < td > Other< / td > < td > ✅< / td > < / tr >
< / tbody > < / table >
2023-12-26 10:07:34 +00:00
< / div > < div style = "break-before: page; page-break-before: always;" > < / div > < h1 id = "examples" > < a class = "header" href = "#examples" > Examples< / a > < / h1 >
2023-12-24 15:51:21 +00:00
< p > This is chapter about how the code in SymboScript looks.< / p >
< / main >
< nav class = "nav-wrapper" aria-label = "Page navigation" >
<!-- Mobile navigation buttons -->
< div style = "clear: both" > < / div >
< / nav >
< / div >
< / div >
< nav class = "nav-wide-wrapper" aria-label = "Page navigation" >
< / nav >
< / div >
< script >
window.playground_copyable = true;
< / script >
< script src = "elasticlunr.min.js" > < / script >
< script src = "mark.min.js" > < / script >
< script src = "searcher.js" > < / script >
< script src = "clipboard.min.js" > < / script >
< script src = "highlight.js" > < / script >
< script src = "book.js" > < / script >
<!-- Custom JS scripts -->
< script >
window.addEventListener('load', function() {
window.setTimeout(window.print, 100);
});
< / script >
< / div >
< / body >
< / html >
