teascade/reid-llvm
1
1
Fork 0
Code Issues Pull Requests Packages Releases 6 Wiki Activity

Add documentation for include_bytes!

Browse Source
This commit is contained in:
Sofia 2025-07-29 16:02:54 +03:00
parent 2303bf757a
commit b0442e5685
2 changed files with 14 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
documentation/README.md
View File

@ -261,6 +261,9 @@ calls, literals, or if-expressions. Types of supported expressions include:
*associated type* with given parameters. *associated type* with given parameters.
- **Accessing function calls**, a shorthand to call associated function calls - **Accessing function calls**, a shorthand to call associated function calls
which have `&self` or `&mut self` as their first parameter. which have `&self` or `&mut self` as their first parameter.
- **Macro invocations** for invoking **macros** which are evaluated at
compile-time rather than runtime. Currently it is not possible to define
your own macros, but there are some pre-defined in the intrinsics.
- **Block-expressions**, which can return a value to the higher-level expression - **Block-expressions**, which can return a value to the higher-level expression
if they have a statement with a soft-return. Otherwise they return void. if they have a statement with a soft-return. Otherwise they return void.
- **If-expressions**, which can execute one of two expressions depending on the - **If-expressions**, which can execute one of two expressions depending on the
@ -278,7 +281,7 @@ In formal grammar:
<indexing> | <accessing> | <indexing> | <accessing> |
<binary-exp> | <unary-exp> | <binary-exp> | <unary-exp> |
<function-call> | <accessing-function-call> | <assoc-function-call> <function-call> | <accessing-function-call> | <assoc-function-call>
<block> | <if-expr> | <cast> | <macro-invocation> | <block> | <if-expr> | <cast> |
( "(" <expression> ")" ) ( "(" <expression> ")" )
<variable> :: <ident> <variable> :: <ident>
@ -294,6 +297,7 @@ In formal grammar:
<function-call> :: <expression> "(" [ <expression> ( "," <expression> )* ] ")" <function-call> :: <expression> "(" [ <expression> ( "," <expression> )* ] ")"
<accessing-function-call> :: <accessing> "(" [ <expression> ( "," <expression> )* ] ")" <accessing-function-call> :: <accessing> "(" [ <expression> ( "," <expression> )* ] ")"
<assoc-function-call> :: <type> "::" <function-call> <assoc-function-call> :: <type> "::" <function-call>
<macro-invocation> :: <expression> "!(" [ <expression> ( "," <expression> )* ] ")"
<if-expr> :: "if" <expression> <expression> [ "else" <expression> ] <if-expr> :: "if" <expression> <expression> [ "else" <expression> ]
<cast> :: <expression> "as" <type> <cast> :: <expression> "as" <type>
``` ```
@ -312,6 +316,7 @@ test.first // Accessing
func(value, 14) // Function call func(value, 14) // Function call
Test::get_field(&test); // Associated function call Test::get_field(&test); // Associated function call
test.get_field(); // Same, but using a the dot-form shorthand test.get_field(); // Same, but using a the dot-form shorthand
include_bytes!("./test"); // Macro invocation
if varname {} else {} // If-expression if varname {} else {} // If-expression
value as u32 // cast value as u32 // cast
(value + 2) // Binop within parenthesis (value + 2) // Binop within parenthesis

8
documentation/intrinsics.md
View File

@ -17,6 +17,14 @@ Allocates `size` bytes and returns a pointer of `u8` of length `size`.
i32::malloc(40); // Reserves 40 bytes i32::malloc(40); // Reserves 40 bytes
``` ```
### Macro Intrinsics
#### `include_bytes!(path: *char) -> &[u8; _]`
Attempts to load file from `path` (relative to module) into memory and includes
it into the compiled binary directly. Returns a borrow to an array containing
bytes from the file. Array length varies depending on the file contents.
### Associated Intrinsics ### Associated Intrinsics
#### `<T>::sizeof() -> u64` #### `<T>::sizeof() -> u64`