Add skeleton of a language reference. #4808
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
The files being checked in here were initially written 2-3 years ago. They are very clearly incomplete, outdated and, quite often, inaccurate. The intention of this change is to get an initial skeleton in place for the large-scale structure of a language reference (for now avoiding the term "specification" and all the weight it carries). Future commits should be able to add to flesh out this skeleton and start to make the document more complete and more accurate.
tangent-vector
added
kind:documentation
csyonghe
approved these changes
Aug 9, 2024
| Identifiers | ||
| ----------- | ||
|
|
||
| An _identifier_ begins with an uppercase or lowercase ASCII letter (`A` through `Z`, `a` through `z`), or an underscore (`_`). |
There was a problem hiding this comment.
It can be any unicode character now.
| The condition may be either a single value of type `bool`, or a vector of `bool`. | ||
| When a vector of `bool` is used, the two values being selected between must be vectors, and selection is performed component-wise. | ||
|
|
||
| > Note: Unlike C, C++, GLSL, and most other C-family languages, Slang currently follows the precedent of HLSL where `?:` does not short-circuit. |
There was a problem hiding this comment.
We do short-circuit by default now.
|
|
||
| ### If Statement | ||
|
|
||
| An _if statement_ consists of the `if` keyword and a conditional expression in parentheses, followed by a statement to execute if the condition is true: |
There was a problem hiding this comment.
We also have
if (let x = optionalValue), where optionalValue is Optional<T> and x is T.
|
|
||
| The value returned must be able to coerce to the result type of the lexically enclosing function. | ||
|
|
||
| ### Discard Statement |
|
|
||
| Operations with side effects that were executed by the invocation before a `discard` will still be performed and their results will become visible according to the rules of the platform. | ||
|
|
||
| Compile-Time For Statement |
| } | ||
| ``` | ||
|
|
||
| It is an error to declare an associated type anywhere other than the body of an interface declaration. |
There was a problem hiding this comment.
Do we want to cover type constraints on associated types?
| { | ||
| ... | ||
|
|
||
| __subscript(int index) -> float |
There was a problem hiding this comment.
we also support multi parameter __subscript.
| In general, the order of declarations within a source unit does not matter; declarations can refer to other declarations (of types, functions, variables, etc.) later in the same source unit. | ||
| Declarations (other than `import` declarations) may freely be defined in any source unit in a module; declarations in one source unit of a module may freely refer to declarations in other source units. | ||
|
|
||
| Imports |
There was a problem hiding this comment.
also need to discuss visibility modifiers.
| Attributes | ||
| ========== | ||
|
|
||
| > Note: This section is not yet complete. |
There was a problem hiding this comment.
need to talk about user defined attributes here.
| * [5 - Expressions](05-expressions.md) | ||
| * [6 - Statements](06-statements.md) | ||
| * [7 - Declarations](07-declarations.md) | ||
| * [8 - Attributes](08-attributes.md) |
There was a problem hiding this comment.
Should have another section on the capability system?
csyonghe
approved these changes
Aug 9, 2024
| Types in Slang do not necessarily prescribe a single _layout_ in memory. | ||
| The discussion of each type will specify any guarantees about layout it provides; any details of layout not specified here may depend on the target platform, compiler options, and context in which a type is used. | ||
|
|
||
| Void Type |
There was a problem hiding this comment.
Should talk about Optional
| | `\|=` | Assignment | compound bitwise or/assign | | ||
| | `^=` | Assignment | compound bitwise xor/assign | | ||
| | `=` | Assignment | assignment | | ||
| | `,` | Sequencing | sequence | |
There was a problem hiding this comment.
we also have is and as operators.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The files being checked in here were initially written 2-3 years ago. They are very clearly incomplete, outdated and, quite often, inaccurate.
The intention of this change is to get an initial skeleton in place for the large-scale structure of a language reference (for now avoiding the term "specification" and all the weight it carries). Future commits should be able to add to flesh out this skeleton and start to make the document more complete and more accurate.