language-servers/roc
1
0
Fork 0
mirror of https://github.com/roc-lang/roc.git synced 2025-10-03 00:24:34 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 6

Parse doc comments

Browse source
This commit is contained in:
Richard Feldman 2020-05-23 21:42:30 -04:00
parent 4d8cbc4811
commit 3dac73d8d0
5 changed files with 138 additions and 67 deletions
Download patch file Download diff file Expand all files Collapse all files

2
compiler/fmt/src/expr.rs
View file

@ -407,7 +407,7 @@ pub fn empty_line_before_expr<'a>(expr: &'a Expr<'a>) -> bool {
has_at_least_one_newline = true;
}
}
CommentOrNewline::LineComment(_) => {}
CommentOrNewline::LineComment(_) | CommentOrNewline::DocComment(_) => {}
}
}

22
compiler/fmt/src/spaces.rs
View file

@ -47,6 +47,11 @@ where
LineComment(comment) => {
fmt_comment(buf, comment, indent);
encountered_comment = true;
}
DocComment(docs) => {
fmt_docs(buf, docs, indent);
encountered_comment = true;
}
}
@ -70,12 +75,16 @@ where
buf.push('#');
buf.push_str(comment);
}
DocComment(docs) => {
buf.push_str("##");
buf.push_str(docs);
}
}
match iter.peek() {
None => {}
Some(next_space) => match next_space {
Newline => {}
LineComment(_) => {
LineComment(_) | DocComment(_) => {
newline(buf, indent);
}
},
@ -96,6 +105,9 @@ where
LineComment(comment) => {
fmt_comment(buf, comment, indent);
}
DocComment(docs) => {
fmt_docs(buf, docs, indent);
}
}
}
}
@ -107,9 +119,17 @@ fn fmt_comment<'a>(buf: &mut String<'a>, comment: &'a str, indent: u16) {
newline(buf, indent);
}
fn fmt_docs<'a>(buf: &mut String<'a>, docs: &'a str, indent: u16) {
buf.push_str("##");
buf.push_str(docs);
newline(buf, indent);
}
pub fn is_comment<'a>(space: &'a CommentOrNewline<'a>) -> bool {
match space {
CommentOrNewline::Newline => false,
CommentOrNewline::LineComment(_) => true,
CommentOrNewline::DocComment(_) => true,
}
}

3
compiler/load/src/file.rs
View file

@ -1,6 +1,5 @@
use bumpalo::Bump;
use roc_builtins::std::Mode;
use roc_builtins::std::StdLib;
use roc_builtins::std::{Mode, StdLib};
use roc_can::constraint::Constraint;
use roc_can::def::Declaration;
use roc_can::module::{canonicalize_module_defs, ModuleOutput};

1
compiler/parse/src/ast.rs
View file

@ -294,6 +294,7 @@ pub enum AssignedField<'a, Val> {
pub enum CommentOrNewline<'a> {
Newline,
LineComment(&'a str),
DocComment(&'a str),
}
#[derive(Clone, Debug, PartialEq)]

105
compiler/parse/src/blankspace.rs
View file

@ -202,6 +202,13 @@ pub fn space1<'a>(min_indent: u16) -> impl Parser<'a, &'a [CommentOrNewline<'a>]
spaces(true, min_indent)
}
#[derive(Debug, Clone, Copy)]
enum LineState {
Normal,
Comment,
DocComment,
}
#[inline(always)]
fn spaces<'a>(
require_at_least_one: bool,
@ -213,38 +220,15 @@ fn spaces<'a>(
let mut space_list = Vec::new_in(arena);
let mut chars_parsed = 0;
let mut comment_line_buf = String::new_in(arena);
let mut is_parsing_comment = false;
let mut line_state = LineState::Normal;
let mut state = state;
let mut any_newlines = false;
for ch in chars {
chars_parsed += 1;
if is_parsing_comment {
match ch {
' ' => {
// If we're in a line comment, this won't affect indentation anyway.
state = state.advance_without_indenting(1)?;
comment_line_buf.push(ch);
}
'\n' => {
state = state.newline()?;
// This was a newline, so end this line comment.
space_list.push(LineComment(comment_line_buf.into_bump_str()));
comment_line_buf = String::new_in(arena);
is_parsing_comment = false;
}
nonblank => {
// Chars can have btye lengths of more than 1!
state = state.advance_without_indenting(nonblank.len_utf8())?;
comment_line_buf.push(nonblank);
}
}
} else {
match line_state {
LineState::Normal => {
match ch {
' ' => {
// Don't check indentation here; it might not be enough
@ -269,7 +253,7 @@ fn spaces<'a>(
.advance_without_indenting(1)?;
// We're now parsing a line comment!
is_parsing_comment = true;
line_state = LineState::Comment;
}
nonblank => {
return if require_at_least_one && chars_parsed <= 1 {
@ -295,6 +279,73 @@ fn spaces<'a>(
}
}
}
LineState::Comment => {
match ch {
' ' => {
// If we're in a line comment, this won't affect indentation anyway.
state = state.advance_without_indenting(1)?;
match comment_line_buf.chars().next() {
Some('#') => {
// This is a comment begining with `## ` - that is,
// a doc comment.
//
// (The space is important; otherwise, this is not
// a doc comment, but rather something like a
// big separator block, e.g. ############)
line_state = LineState::DocComment;
// This is now the beginning of the doc comment.
comment_line_buf.clear();
}
_ => {
comment_line_buf.push(ch);
}
}
}
'\n' => {
state = state.newline()?;
// This was a newline, so end this line comment.
space_list.push(LineComment(comment_line_buf.into_bump_str()));
comment_line_buf = String::new_in(arena);
line_state = LineState::Normal;
}
nonblank => {
// Chars can have btye lengths of more than 1!
state = state.advance_without_indenting(nonblank.len_utf8())?;
comment_line_buf.push(nonblank);
}
}
}
LineState::DocComment => {
match ch {
' ' => {
// If we're in a doc comment, this won't affect indentation anyway.
state = state.advance_without_indenting(1)?;
comment_line_buf.push(ch);
}
'\n' => {
state = state.newline()?;
// This was a newline, so end this doc comment.
space_list.push(DocComment(comment_line_buf.into_bump_str()));
comment_line_buf = String::new_in(arena);
line_state = LineState::Normal;
}
nonblank => {
// Chars can have btye lengths of more than 1!
state = state.advance_without_indenting(nonblank.len_utf8())?;
comment_line_buf.push(nonblank);
}
}
}
}
}
if require_at_least_one && chars_parsed == 0 {