Skip to content
Draft
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
60 changes: 59 additions & 1 deletion standard/lexical-structure.md
Original file line number Diff line number Diff line change
Expand Up @@ -1494,7 +1494,7 @@

Line directives may be used to alter the line numbers and compilation unit names that are reported by a compiler in output such as warnings and errors. These values are also used by caller-info attributes ([§23.5.6](attributes.md#2356-caller-info-attributes)).

> *Note*: Line directives are most commonly used in meta-programming tools that generate C# source code from some other text input. *end note*
> *Note*: Line directives are most commonly used in meta-programming tools that generate C# source code from some other text input. The information these directives provide might be used for debugging purposes and error handling, by allowing mapping of errors back to the original source file, rather than to the generated intermediate file. *end note*

```ANTLR
fragment PP_Line
Expand All @@ -1505,7 +1505,9 @@
: Decimal_Digit+ PP_Whitespace PP_Compilation_Unit_Name
| Decimal_Digit+
| DEFAULT
| 'hidden'

Check warning on line 1508 in standard/lexical-structure.md

View workflow job for this annotation

GitHub Actions / Markdown to Word Converter

standard/lexical-structure.md#L1508

MDC032::Line length 85 > maximum 81
| PP_Start_Line_Character PP_Whitespace? '-' PP_Whitespace? PP_End_Line_Character
PP_Whitespace (PP_Character_Offset PP_Whitespace)? PP_Compilation_Unit_Name
;

fragment PP_Compilation_Unit_Name
Expand All @@ -1516,6 +1518,35 @@
// Any Input_Character except "
: ~('\u000D' | '\u000A' | '\u0085' | '\u2028' | '\u2029' | '"')
;

fragment PP_Start_Line_Character
: '(' PP_Whitespace? PP_Start_Line PP_Whitespace? ',' PP_Whitespace?
PP_Start_Character PP_Whitespace? ')'
;
fragment PP_End_Line_Character
: '(' PP_Whitespace? PP_End_Line PP_Whitespace? ',' PP_Whitespace?
PP_End_Character PP_Whitespace? ')'
;

fragment PP_Start_Line
: Decimal_Digit+
;

fragment PP_End_Line
: Decimal_Digit+
;

fragment PP_Start_Character
: Decimal_Digit+
;

fragment PP_End_Character
: Decimal_Digit+
;

fragment PP_Character_Offset
: Decimal_Digit+
;
```

When no `#line` directives are present, a compiler reports true line numbers and compilation unit names in its output. When processing a `#line` directive that includes a *PP_Line_Indicator* that is not `default`, a compiler treats the line *after* the directive as having the given line number (and compilation unit name, if specified).
Expand All @@ -1528,6 +1559,33 @@

> *Note*: Although a *PP_Compilation_Unit_Name* might contain text that looks like an escape sequence, such text is not an escape sequence; in this context a ‘`\`’ character simply designates an ordinary backslash character. *end note*

Together, the tokens *Start_Line_Character* '-' *PP_End_Line_Character* specify a span of characters in the so-called mapped file *PP_Compilation_Unit_Name*.

*PP_Start_Line_Character* represents the start line (*PP_Start_Line*) and column (*PP_Start_Character*) pair of the first character on the line following the directive, which is the mapped file text; for example, `(1,1)`.

*PP_End_Line_Character* represents the end line (*PP_End_Line*) and column (*PP_End_Character*) pair of the mapped file text; for example, `(3,10)`.

*PP_Start_Line* and *PP_End_Line* are positive integers that specify line numbers. *PP_Start_Character* and *PP_End_Character* are positive integers that specify UTF-16 character numbers. All four of these numbers are 1-based, meaning that the first line of the mapped file and the first UTF-16 character on each line is assigned number 1.
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The two occurrences of "UTF-16" were retained from the MS spec. However, they can probably be removed. See Rex's Unicode-related PR #1103, “Tweak Some Unicode-Related Text.”


By default, the mapped text starts at the first character on the line following the `#line` directive. However, this can be adjusted using *PP_Character_Offset*. If *PP_Character_Offset* is omitted, it defaults to 0; otherwise, it specifies the number of UTF-16 characters to skip in that next line. That number shall be non-negative and less than the length of the line following the `#line` directive.

The mapping specified by a *PP_Line* is in scope until the following `#line` directive or the end of the compilation unit, whichever comes first.

> *Example*: Consider the following:
>
> <!-- PendingAnExample: {template:"standalone-console", name:"LineWithMapping"} -->
> ```csharp
> // example goes here
> ```
>
> the output produced might be something like the following:
>
> ```console
> ???
> ```
>
> *end example*

### 6.5.9 Nullable directive

The nullable directive controls the nullable context, as described below.
Expand Down
Loading