Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Parse docstrings within structs as K"doc" #511

Merged
merged 1 commit into from
Oct 6, 2024
Merged

Parse docstrings within structs as K"doc" #511

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
13 changes: 13 additions & 0 deletions src/expr.jl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -466,6 +466,19 @@ function _internal_node_to_Expr(source, srcrange, head, childranges, childheads,
headsym = :call
pushfirst!(args, :*)
elseif k == K"struct"
@assert args[2].head == :block
orig_fields = args[2].args
fields = Expr(:block)
for field in orig_fields
if @isexpr(field, :macrocall) && field.args[1] == GlobalRef(Core, Symbol("@doc"))
# @doc macro calls don't occur within structs, in Expr form.
push!(fields.args, field.args[3])
push!(fields.args, field.args[4])
else
push!(fields.args, field)
end
end
args[2] = fields
pushfirst!(args, has_flags(head, MUTABLE_FLAG))
elseif k == K"importpath"
headsym = :.
Expand Down
8 changes: 4 additions & 4 deletions src/parser.jl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -536,9 +536,9 @@ end
# Parse docstrings attached by a space or single newline
#
# flisp: parse-docstring
function parse_docstring(ps::ParseState)
function parse_docstring(ps::ParseState, down=parse_eq)
mark = position(ps)
parse_eq(ps)
down(ps)
if peek_behind(ps).kind == K"string"
is_doc = true
k = peek(ps)
Expand All @@ -563,7 +563,7 @@ function parse_docstring(ps::ParseState)
# """\n doc\n """ foo ==> (doc (string-s "doc\n") foo)
end
if is_doc
parse_eq(ps)
down(ps)
emit(ps, mark, K"doc")
end
end
Expand Down Expand Up @@ -1947,7 +1947,7 @@ function parse_resword(ps::ParseState)
@check peek(ps) == K"struct"
bump(ps, TRIVIA_FLAG)
parse_subtype_spec(ps)
parse_block(ps, parse_struct_field)
parse_block(ps, ps1->parse_docstring(ps1, parse_struct_field))
bump_closing_token(ps, K"end")
emit(ps, mark, K"struct", is_mut ? MUTABLE_FLAG : EMPTY_FLAGS)
elseif word == K"primitive"
Expand Down
3 changes: 3 additions & 0 deletions test/expr.jl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -727,6 +727,9 @@
Expr(:block, LineNumberNode(2), :a, LineNumberNode(3), :b))
@test parsestmt("struct A const a end", version=v"1.8") ==
Expr(:struct, false, :A, Expr(:block, LineNumberNode(1), Expr(:const, :a)))

@test parsestmt("struct A \n \"doc\" \n a end") ==
Expr(:struct, false, :A, Expr(:block, LineNumberNode(2), "doc", :a))
end

@testset "export" begin
Expand Down
1 change: 1 addition & 0 deletions test/parser.jl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -502,6 +502,7 @@ tests = [
# struct
"struct A <: B \n a::X \n end" => "(struct (<: A B) (block (::-i a X)))"
"struct A \n a \n b \n end" => "(struct A (block a b))"
"struct A \n \"doca\" \n a \n \"docb\" \n b \n end" => "(struct A (block (doc (string \"doca\") a) (doc (string \"docb\") b)))"
"mutable struct A end" => "(struct-mut A (block))"
((v=v"1.8",), "struct A const a end") => "(struct A (block (const a)))"
((v=v"1.7",), "struct A const a end") => "(struct A (block (error (const a))))"
Expand Down
Loading