Weave.jl/src/readers.jl

313 lines
8.3 KiB
Julia
Raw Normal View History

2016-12-14 20:50:29 +01:00
import JSON, YAML
2016-12-11 19:23:19 +01:00
pushopt(options::Dict,expr::Expr) = Base.Meta.isexpr(expr,:(=)) && (options[expr.args[1]] = expr.args[2])
2017-12-31 13:02:28 +01:00
mutable struct MarkupInput
codestart::Regex
codeend::Regex
2016-12-26 19:06:03 +01:00
inline::Regex
end
2017-12-31 13:02:28 +01:00
mutable struct ScriptInput
doc_line::Regex
doc_start::Regex
opt_line::Regex
opt_start::Regex
2016-12-26 19:06:03 +01:00
inline::Regex
end
2014-12-05 23:17:54 +01:00
2017-12-31 13:02:28 +01:00
mutable struct NotebookInput
2016-12-26 19:06:03 +01:00
inline
2016-12-11 19:23:19 +01:00
end
const input_formats = Dict{AbstractString, Any}(
"noweb" => MarkupInput(r"^<<(.*?)>>=\s*$",
2016-12-26 19:06:03 +01:00
r"^@\s*$",
r"`j\s+(.*?)`"s
),
"markdown" => MarkupInput(
r"^[`~]{3,}(?:\{|\{\.|)julia(?:;|)\s*(.*?)(\}|\s*)$",
2016-12-26 19:06:03 +01:00
r"^[`~]{3,}\s*$",
r"`j\s+(.*?)`"s),
"script" => ScriptInput(
r"(^#'.*)|(^#%%.*)|(^# %%.*)",
r"(^#')|(^#%%)|(^# %%)",
r"(^#\+.*$)|(^#%%\+.*$)|(^# %%\+.*$)",
2016-12-26 19:06:03 +01:00
r"(^#\+)|(^#%%\+)|(^# %%\+)",
r"`j\s+(.*?)`"s),
"notebook" => NotebookInput(nothing) #Don't parse inline code from notebooks
2014-12-05 23:17:54 +01:00
)
"""Detect the input format based on file extension"""
function detect_informat(source::AbstractString)
ext = lowercase(splitext(source)[2])
ext == ".jl" && return "script"
ext == ".jmd" && return "markdown"
2016-12-11 19:23:19 +01:00
ext == ".ipynb" && return "notebook"
return "noweb"
end
"""Read and parse input document"""
function read_doc(source::AbstractString, format=:auto)
format == :auto && (format = detect_informat(source))
document = read(source, String)
2018-07-23 19:29:07 +02:00
document = replace(document, "\r\n" => "\n")
parsed = parse_doc(document, format)
2016-12-14 20:50:29 +01:00
header = parse_header(parsed[1])
doc = WeaveDoc(source, parsed, header)
haskey(header, "options") && header_chunk_defaults!(doc)
2016-12-14 20:50:29 +01:00
return doc
end
function parse_header(chunk::CodeChunk)
return Dict()
2016-12-14 20:50:29 +01:00
end
function parse_header(chunk::DocChunk)
2016-12-26 19:06:03 +01:00
m = match(r"^---$(?<header>.+)^---$"ms, chunk.content[1].content)
2016-12-14 20:50:29 +01:00
if m !== nothing
header = YAML.load(string(m[:header]))
else
header = Dict()
2016-12-14 20:50:29 +01:00
end
return header
end
2016-04-11 17:40:18 +02:00
function parse_doc(document::AbstractString, format="noweb"::AbstractString)
return parse_doc(document, input_formats[format])
end
"""Parse documents with Weave.jl markup"""
function parse_doc(document::AbstractString, format::MarkupInput)
2018-07-23 19:29:07 +02:00
document = replace(document, "\r\n" => "\n")
lines = split(document, "\n")
2014-12-03 22:34:29 +01:00
codestart = format.codestart
codeend = format.codeend
state = "doc"
docno = 1
codeno = 1
content = ""
start_line = 0
options = Dict()
2016-04-20 20:31:55 +02:00
optionString = ""
parsed = Any[]
for lineno in 1:length(lines)
line = lines[lineno]
if (m = match(codestart, line)) != nothing && state=="doc"
state = "code"
2014-12-06 15:40:50 +01:00
if m.captures[1] == nothing
2016-04-20 20:31:55 +02:00
optionString = ""
2014-12-06 15:40:50 +01:00
else
2016-04-20 20:31:55 +02:00
optionString=strip(m.captures[1])
2014-12-06 15:40:50 +01:00
end
options = Dict{Symbol,Any}()
2016-04-20 20:31:55 +02:00
if length(optionString) > 0
expr = Meta.parse(optionString)
Base.Meta.isexpr(expr,:(=)) && (options[expr.args[1]] = expr.args[2])
Base.Meta.isexpr(expr,:toplevel) && map(pushopt,fill(options,length(expr.args)),expr.args)
end
haskey(options, :label) && (options[:name] = options[:label])
haskey(options, :name) || (options[:name] = nothing)
if !isempty(strip(content))
2016-12-26 19:06:03 +01:00
chunk = DocChunk(content, docno, start_line, format.inline)
docno += 1
push!(parsed, chunk)
end
content = ""
start_line = lineno
continue
end
if occursin(codeend, line) && state=="code"
2016-04-20 20:31:55 +02:00
chunk = CodeChunk(content, codeno, start_line, optionString, options)
codeno+=1
start_line = lineno
content = ""
state = "doc"
push!(parsed, chunk)
continue
end
if lineno == 1
content *= line
else
content *= "\n" * line
end
end
#Remember the last chunk
if strip(content) != ""
2016-12-26 19:06:03 +01:00
chunk = DocChunk(content, docno, start_line, format.inline)
2016-11-03 09:41:29 +01:00
#chunk = Dict{Symbol,Any}(:type => "doc", :content => content,
# :number => docno, :start_line => start_line)
push!(parsed, chunk)
end
return parsed
2014-12-01 22:06:57 +01:00
end
"""Parse .jl scripts with Weave.jl markup"""
function parse_doc(document::AbstractString, format::ScriptInput)
2018-07-23 19:35:15 +02:00
document = replace(document, "\r\n" => "\n")
lines = split(document, "\n")
doc_line = format.doc_line
doc_start = format.doc_start
opt_line = format.opt_line
opt_start = format.opt_start
read = ""
chunks = []
docno = 1
codeno = 1
content = ""
start_line = 1
options = Dict{Symbol,Any}()
optionString = ""
parsed = Any[]
state = "code"
lineno = 1
n_emptylines = 0
for lineno in 1:length(lines)
line = lines[lineno]
if (m = match(doc_line, line)) != nothing && (m = match(opt_line, line)) == nothing
2018-07-23 19:35:15 +02:00
line = replace(line, doc_start => "", count=1)
if startswith(line, " ")
2018-07-23 19:35:15 +02:00
line = replace(line, " " => "", count=1)
end
if state == "code" && strip(read) != ""
chunk = CodeChunk("\n" * strip(read), codeno, start_line, optionString, options)
push!(parsed, chunk)
codeno +=1
read = ""
start_line = lineno
end
state = "doc"
elseif (m = match(opt_line, line)) != nothing
start_line = lineno
if state == "code" && strip(read) !=""
chunk = CodeChunk("\n" * strip(read), codeno, start_line, optionString, options)
push!(parsed, chunk)
read = ""
codeno +=1
end
if state == "doc" && strip(read) != ""
(docno > 1) && (read = "\n" * read) # Add whitespace to doc chunk. Needed for markdown output
chunk = DocChunk(read, docno, start_line)
push!(parsed, chunk)
read = ""
docno += 1
end
2018-07-23 19:35:15 +02:00
optionString = replace(line, opt_start => "", count=1)
#Get options
options = Dict{Symbol,Any}()
if length(optionString) > 0
expr = Meta.parse(optionString)
Base.Meta.isexpr(expr,:(=)) && (options[expr.args[1]] = expr.args[2])
Base.Meta.isexpr(expr,:toplevel) && map(pushopt,fill(options,length(expr.args)),expr.args)
end
haskey(options, :label) && (options[:name] = options[:label])
haskey(options, :name) || (options[:name] = nothing)
state = "code"
continue
2018-01-02 14:48:56 +01:00
elseif state == "doc" #&& strip(line) != "" && strip(read) != ""
state = "code"
(docno > 1) && (read = "\n" * read) # Add whitespace to doc chunk. Needed for markdown output
2016-12-26 19:06:03 +01:00
chunk = DocChunk(read, docno, start_line, format.inline)
push!(parsed, chunk)
options = Dict{Symbol,Any}()
start_line = lineno
read = ""
docno += 1
end
read *= line * "\n"
if strip(line) == ""
n_emptylines += 1
else
n_emptylines = 0
end
end
# Handle the last chunk
if state == "code"
chunk = CodeChunk("\n" * strip(read), codeno, start_line, optionString, options)
push!(parsed, chunk)
else
2016-12-26 19:06:03 +01:00
chunk = DocChunk(read, docno, start_line, format.inline)
push!(parsed, chunk)
end
return parsed
end
2016-12-11 19:23:19 +01:00
"""Parse IJUlia notebook"""
function parse_doc(document::String, format::NotebookInput)
2018-07-23 19:29:07 +02:00
document = replace(document, "\r\n" => "\n")
2016-12-11 19:23:19 +01:00
nb = JSON.parse(document)
parsed = Any[]
options = Dict{Symbol,Any}()
opt_string = ""
docno = 1
codeno = 1
for cell in nb["cells"]
srctext = "\n" * join(cell["source"], "")
if cell["cell_type"] == "code"
chunk = CodeChunk(rstrip(srctext), codeno, 0, opt_string, options)
push!(parsed, chunk)
codeno += 1
else
chunk = DocChunk(srctext * "\n", docno, 0)
push!(parsed, chunk)
docno +=1
end
end
return parsed
end
2016-12-26 19:06:03 +01:00
#Use this if regex is undefined
function parse_inline(text, noex)
2016-12-27 20:43:13 +01:00
return Inline[InlineText(text, 1, length(text), 1)]
2016-12-26 19:06:03 +01:00
end
function parse_inline(text::AbstractString, inline_ex::Regex)
occursin(inline_ex, text) || return Inline[InlineText(text, 1, length(text), 1)]
2016-12-26 19:06:03 +01:00
inline_chunks = eachmatch(inline_ex, text)
s = 1
e = 1
res = Inline[]
2016-12-27 20:43:13 +01:00
textno = 1
codeno = 1
2016-12-26 19:06:03 +01:00
for ic in inline_chunks
s = ic.offset
2016-12-27 20:43:13 +01:00
doc = InlineText(text[e:(s-1)], e, s-1, textno)
textno += 1
2016-12-26 19:06:03 +01:00
push!(res, doc)
e = s + lastindex(ic.match)
2016-12-27 20:43:13 +01:00
push!(res, InlineCode(ic.captures[1], s, e, codeno))
codeno += 1
2016-12-26 19:06:03 +01:00
end
2016-12-27 20:43:13 +01:00
push!(res, InlineText(text[e:end], e, length(text), textno))
2016-12-26 19:06:03 +01:00
return res
end