diff --git a/compiler/ccgmerge.nim b/compiler/ccgmerge.nim
index 45463a397d..311711f5aa 100644
--- a/compiler/ccgmerge.nim
+++ b/compiler/ccgmerge.nim
@@ -169,7 +169,7 @@ proc readVerbatimSection(L: var TBaseLexer): PRope =
result.data.add(buf[pos])
inc pos
L.bufpos = pos
- result.length = result.data.len
+ freezeMutableRope(result)
proc readKey(L: var TBaseLexer, result: var string) =
var pos = L.bufpos
diff --git a/compiler/commands.nim b/compiler/commands.nim
index 347e7aa046..cec0bbe6bd 100755
--- a/compiler/commands.nim
+++ b/compiler/commands.nim
@@ -366,8 +366,7 @@ proc processSwitch(switch, arg: string, pass: TCmdlinePass, info: TLineInfo) =
expectArg(switch, arg, pass, info)
if pass in {passCmd2, passPP}: cLinkedLibs.add arg
of "index":
- expectArg(switch, arg, pass, info)
- if pass in {passCmd2, passPP}: gIndexFile = arg
+ ProcessOnOffSwitchG({optGenIndex}, arg, pass, info)
of "import":
expectArg(switch, arg, pass, info)
if pass in {passCmd2, passPP}: implicitImports.add arg
diff --git a/compiler/docgen.nim b/compiler/docgen.nim
index 50abcfc4e2..6e249b888b 100755
--- a/compiler/docgen.nim
+++ b/compiler/docgen.nim
@@ -12,56 +12,19 @@
# by knowing how the anchors are going to be named.
import
- ast, astalgo, strutils, hashes, options, nversion, msgs, os, ropes, idents,
+ ast, strutils, strtabs, options, msgs, os, ropes, idents,
wordrecg, syntaxes, renderer, lexer, rstast, rst, rstgen, times, highlite,
importer
-proc CommandDoc*()
-proc CommandRst2Html*()
-proc CommandRst2TeX*()
-
-#proc CommandBuildIndex*()
-# implementation
-
-type
- TTocEntry{.final.} = object
- n*: PRstNode
- refname*, header*: PRope
-
+type
TSections = array[TSymKind, PRope]
- TMetaEnum = enum
- metaNone, metaTitle, metaSubtitle, metaAuthor, metaVersion
- TDocumentor {.final.} = object # contains a module's documentation
- target: TOutputTarget
- options: TRstParseOptions
- filename*: string # filename of the source file; without extension
- modDesc*: PRope # module description
- id*: int # for generating IDs
- splitAfter*: int # split too long entries in the TOC
- tocPart*: seq[TTocEntry]
- hasToc*: bool
- toc*, section*: TSections
- indexFile*, theIndex*: PRstNode
- indexValFilename*: string
- meta*: array[TMetaEnum, PRope]
+ TDocumentor = object of rstgen.TRstGenerator
+ modDesc: PRope # module description
+ id: int # for generating IDs
+ toc, section: TSections
+ indexValFilename: string
PDoc = ref TDocumentor
-
-proc findIndexNode(n: PRstNode): PRstNode =
- if n == nil:
- result = nil
- elif n.kind == rnIndex:
- result = n.sons[2]
- if result == nil:
- result = newRstNode(rnDefList)
- n.sons[2] = result
- elif result.kind == rnInner:
- result = result.sons[0]
- else:
- result = nil
- for i in countup(0, len(n) - 1):
- result = findIndexNode(n.sons[i])
- if result != nil: return
proc compilerMsgHandler(filename: string, line, col: int,
msgKind: rst.TMsgKind, arg: string) {.procvar.} =
@@ -76,6 +39,7 @@ proc compilerMsgHandler(filename: string, line, col: int,
of meInvalidDirective: k = errInvalidDirectiveX
of mwRedefinitionOfLabel: k = warnRedefinitionOfLabel
of mwUnknownSubstitution: k = warnUnknownSubstitutionX
+ of mwUnsupportedLanguage: k = warnLanguageXNotSupported
GlobalError(newLineInfo(filename, line, col), k, arg)
proc parseRst(text, filename: string,
@@ -83,45 +47,17 @@ proc parseRst(text, filename: string,
rstOptions: TRstParseOptions): PRstNode =
result = rstParse(text, filename, line, column, hasToc, rstOptions,
options.FindFile, compilerMsgHandler)
-
-proc initIndexFile(d: PDoc) =
- var
- h: PRstNode
- dummyHasToc: bool
- if gIndexFile.len == 0: return
- gIndexFile = addFileExt(gIndexFile, "txt")
- d.indexValFilename = changeFileExt(extractFilename(d.filename), HtmlExt)
- if ExistsFile(gIndexFile):
- d.indexFile = parseRst(readFile(gIndexFile), gIndexFile, 0, 1,
- dummyHasToc, {roSupportRawDirective})
- d.theIndex = findIndexNode(d.indexFile)
- if (d.theIndex == nil) or (d.theIndex.kind != rnDefList):
- rawMessage(errXisNoValidIndexFile, gIndexFile)
- clearIndex(d.theIndex, d.indexValFilename)
- else:
- d.indexFile = newRstNode(rnInner)
- h = newRstNode(rnOverline)
- h.level = 1
- add(h, newRstNode(rnLeaf, "Index"))
- add(d.indexFile, h)
- h = newRstNode(rnIndex)
- add(h, nil) # no argument
- add(h, nil) # no options
- d.theIndex = newRstNode(rnDefList)
- add(h, d.theIndex)
- add(d.indexFile, h)
-proc newDocumentor(filename: string): PDoc =
+proc newDocumentor(filename: string, config: PStringTable): PDoc =
new(result)
- if gCmd != cmdRst2Tex: result.target = outHtml
- else: result.target = outLatex
- result.tocPart = @[]
- result.filename = filename
+ initRstGenerator(result[], (if gCmd != cmdRst2Tex: outHtml else: outLatex),
+ options.gConfigVars, filename, {roSupportRawDirective},
+ options.FindFile, compilerMsgHandler)
result.id = 100
- result.splitAfter = 20
- result.options = {roSupportRawDirective}
- var s = getConfigVar("split.item.toc")
- if s != "": result.splitAfter = parseInt(s)
+
+proc dispA(dest: var PRope, xml, tex: string, args: openarray[PRope]) =
+ if gCmd != cmdRst2Tex: appf(dest, xml, args)
+ else: appf(dest, tex, args)
proc getVarIdx(varnames: openarray[string], id: string): int =
for i in countup(0, high(varnames)):
@@ -183,76 +119,37 @@ proc ropeFormatNamedVars(frmt: TFormatStr, varnames: openarray[string],
else: break
if i - 1 >= start: app(result, substr(frmt, start, i - 1))
-proc disp(xml, tex: string): string =
- if gCmd != cmdRst2Tex: result = xml
- else: result = tex
-
-proc dispF(xml, tex: string, args: openarray[PRope]): PRope =
- if gCmd != cmdRst2Tex: result = ropef(xml, args)
- else: result = ropef(tex, args)
-
-proc dispA(dest: var PRope, xml, tex: string, args: openarray[PRope]) =
- if gCmd != cmdRst2Tex: appf(dest, xml, args)
- else: appf(dest, tex, args)
-
-proc renderRstToOut(d: PDoc, n: PRstNode): PRope
-
-proc renderAux(d: PDoc, n: PRstNode, outer: string = "$1"): PRope =
- result = nil
- for i in countup(0, len(n) - 1): app(result, renderRstToOut(d, n.sons[i]))
- result = ropef(outer, [result])
-
-proc setIndexForSourceTerm(d: PDoc, name: PRstNode, id: int) =
- if d.theIndex == nil: return
- var h = newRstNode(rnHyperlink)
- var a = newRstNode(rnLeaf, d.indexValFilename & disp("#", "") & $id)
- add(h, a)
- add(h, a)
- a = newRstNode(rnIdx)
- add(a, name)
- setIndexPair(d.theIndex, a, h)
-
-proc renderIndexTerm(d: PDoc, n: PRstNode): PRope =
- inc(d.id)
- result = dispF("$2", "$2\\label{$1}",
- [toRope(d.id), renderAux(d, n)])
- var h = newRstNode(rnHyperlink)
- var a = newRstNode(rnLeaf, d.indexValFilename & disp("#", "") & $d.id)
- add(h, a)
- add(h, a)
- setIndexPair(d.theIndex, n, h)
-
-proc genComment(d: PDoc, n: PNode): PRope =
+proc genComment(d: PDoc, n: PNode): string =
+ result = ""
var dummyHasToc: bool
if n.comment != nil and startsWith(n.comment, "##"):
- result = renderRstToOut(d, parseRst(n.comment, toFilename(n.info),
- toLineNumber(n.info), toColumn(n.info),
- dummyHasToc,
- d.options + {roSkipPounds}))
-
+ renderRstToOut(d[], parseRst(n.comment, toFilename(n.info),
+ toLineNumber(n.info), toColumn(n.info),
+ dummyHasToc, d.options + {roSkipPounds}), result)
+
proc genRecComment(d: PDoc, n: PNode): PRope =
if n == nil: return nil
- result = genComment(d, n)
+ result = genComment(d, n).toRope
if result == nil:
- if not (n.kind in {nkEmpty..nkNilLit}):
- for i in countup(0, sonsLen(n) - 1):
+ if n.kind notin {nkEmpty..nkNilLit}:
+ for i in countup(0, len(n)-1):
result = genRecComment(d, n.sons[i])
if result != nil: return
- else:
+ else:
n.comment = nil
proc isVisible(n: PNode): bool =
result = false
if n.kind == nkPostfix:
- if (sonsLen(n) == 2) and (n.sons[0].kind == nkIdent):
+ if n.len == 2 and n.sons[0].kind == nkIdent:
var v = n.sons[0].ident
- result = (v.id == ord(wStar)) or (v.id == ord(wMinus))
- elif n.kind == nkSym:
+ result = v.id == ord(wStar) or v.id == ord(wMinus)
+ elif n.kind == nkSym:
result = sfExported in n.sym.flags
- elif n.kind == nkPragmaExpr:
+ elif n.kind == nkPragmaExpr:
result = isVisible(n.sons[0])
-proc getName(d: PDoc, n: PNode, splitAfter: int = - 1): string =
+proc getName(d: PDoc, n: PNode, splitAfter = -1): string =
case n.kind
of nkPostfix: result = getName(d, n.sons[1], splitAfter)
of nkPragmaExpr: result = getName(d, n.sons[0], splitAfter)
@@ -334,288 +231,8 @@ proc genItem(d: PDoc, n, nameNode: PNode, k: TSymKind) =
app(d.toc[k], ropeFormatNamedVars(getConfigVar("doc.item.toc"),
["name", "header", "desc", "itemID"], [
toRope(getName(d, nameNode, d.splitAfter)), result, comm, toRope(d.id)]))
- setIndexForSourceTerm(d, getRstName(nameNode), d.id)
+ setIndexTerm(d[], $d.id, getName(d, nameNode))
-proc renderHeadline(d: PDoc, n: PRstNode): PRope =
- result = nil
- for i in countup(0, len(n) - 1): app(result, renderRstToOut(d, n.sons[i]))
- var refname = toRope(rstnodeToRefname(n))
- if d.hasToc:
- var length = len(d.tocPart)
- setlen(d.tocPart, length + 1)
- d.tocPart[length].refname = refname
- d.tocPart[length].n = n
- d.tocPart[length].header = result
- result = dispF(
- "$3",
- "\\rsth$4{$3}\\label{$2}$n", [toRope(n.level),
- d.tocPart[length].refname, result,
- toRope(chr(n.level - 1 + ord('A')) & "")])
- else:
- result = dispF("$3", "\\rsth$4{$3}\\label{$2}$n", [
- toRope(n.level), refname, result,
- toRope(chr(n.level - 1 + ord('A')) & "")])
-
-proc renderOverline(d: PDoc, n: PRstNode): PRope =
- var t: PRope = nil
- for i in countup(0, len(n) - 1): app(t, renderRstToOut(d, n.sons[i]))
- result = nil
- if d.meta[metaTitle] == nil:
- d.meta[metaTitle] = t
- elif d.meta[metaSubtitle] == nil:
- d.meta[metaSubtitle] = t
- else:
- result = dispF("$3",
- "\\rstov$4{$3}\\label{$2}$n", [toRope(n.level),
- toRope(rstnodeToRefname(n)), t, toRope($chr(n.level - 1 + ord('A')))])
-
-
-proc renderTocEntry(d: PDoc, e: TTocEntry): PRope =
- result = dispF(
- "$2$n",
- "\\item\\label{$1_toc} $2\\ref{$1}$n", [e.refname, e.header])
-
-proc renderTocEntries(d: PDoc, j: var int, lvl: int): PRope =
- result = nil
- while j <= high(d.tocPart):
- var a = abs(d.tocPart[j].n.level)
- if a == lvl:
- app(result, renderTocEntry(d, d.tocPart[j]))
- inc(j)
- elif a > lvl:
- app(result, renderTocEntries(d, j, a))
- else:
- break
- if lvl > 1:
- result = dispF("",
- "\\begin{enumerate}$1\\end{enumerate}", [result])
-
-proc fieldAux(s: string): PRope =
- result = toRope(strip(s))
-
-proc renderImage(d: PDoc, n: PRstNode): PRope =
- var options: PRope = nil
- var s = getFieldValue(n, "scale")
- if s != "": dispA(options, " scale=\"$1\"", " scale=$1", [fieldAux(s)])
- s = getFieldValue(n, "height")
- if s != "": dispA(options, " height=\"$1\"", " height=$1", [fieldAux(s)])
- s = getFieldValue(n, "width")
- if s != "": dispA(options, " width=\"$1\"", " width=$1", [fieldAux(s)])
- s = getFieldValue(n, "alt")
- if s != "": dispA(options, " alt=\"$1\"", "", [fieldAux(s)])
- s = getFieldValue(n, "align")
- if s != "": dispA(options, " align=\"$1\"", "", [fieldAux(s)])
- if options != nil: options = dispF("$1", "[$1]", [options])
- result = dispF("![](\"$1\"$2)
", "\\includegraphics$2{$1}",
- [toRope(getArgument(n)), options])
- if len(n) >= 3: app(result, renderRstToOut(d, n.sons[2]))
-
-proc renderSmiley(d: PDoc, n: PRstNode): PRope =
- result = dispF(
- """
""",
- "\\includegraphics{$1}", [toRope(n.text)])
-
-proc renderCodeBlock(d: PDoc, n: PRstNode): PRope =
- result = nil
- if n.sons[2] == nil: return
- var m = n.sons[2].sons[0]
- if (m.kind != rnLeaf): InternalError("renderCodeBlock")
- var langstr = strip(getArgument(n))
- var lang: TSourceLanguage
- if langstr == "":
- lang = langNimrod # default language
- else:
- lang = getSourceLanguage(langstr)
- if lang == langNone:
- rawMessage(warnLanguageXNotSupported, langstr)
- result = toRope(m.text)
- else:
- var g: TGeneralTokenizer
- initGeneralTokenizer(g, m.text)
- while true:
- getNextToken(g, lang)
- case g.kind
- of gtEof: break
- of gtNone, gtWhitespace:
- app(result, substr(m.text, g.start, g.length + g.start - 1))
- else:
- dispA(result, "$1", "\\span$2{$1}", [
- toRope(esc(d.target, substr(m.text, g.start, g.length+g.start-1))),
- toRope(tokenClassToStr[g.kind])])
- deinitGeneralTokenizer(g)
- if result != nil:
- result = dispF("$1
", "\\begin{rstpre}$n$1$n\\end{rstpre}$n",
- [result])
-
-proc renderContainer(d: PDoc, n: PRstNode): PRope =
- result = renderRstToOut(d, n.sons[2])
- var arg = toRope(strip(getArgument(n)))
- if arg == nil: result = dispF("$1
", "$1", [result])
- else: result = dispF("$2
", "$2", [arg, result])
-
-proc texColumns(n: PRstNode): string =
- result = ""
- for i in countup(1, len(n)): add(result, "|X")
-
-proc renderField(d: PDoc, n: PRstNode): PRope =
- var b = false
- if gCmd == cmdRst2Tex:
- var fieldname = addNodes(n.sons[0])
- var fieldval = toRope(esc(d.target, strip(addNodes(n.sons[1]))))
- if cmpIgnoreStyle(fieldname, "author") == 0:
- if d.meta[metaAuthor] == nil:
- d.meta[metaAuthor] = fieldval
- b = true
- elif cmpIgnoreStyle(fieldName, "version") == 0:
- if d.meta[metaVersion] == nil:
- d.meta[metaVersion] = fieldval
- b = true
- if b: result = nil
- else: result = renderAux(d, n, disp("$1
$n", "$1"))
-
-proc renderRstToOut(d: PDoc, n: PRstNode): PRope =
- if n == nil:
- return nil
- case n.kind
- of rnInner: result = renderAux(d, n)
- of rnHeadline: result = renderHeadline(d, n)
- of rnOverline: result = renderOverline(d, n)
- of rnTransition: result = renderAux(d, n, disp("
\n", "\\hrule\n"))
- of rnParagraph: result = renderAux(d, n, disp("$1
\n", "$1$n$n"))
- of rnBulletList:
- result = renderAux(d, n, disp("\n",
- "\\begin{itemize}$1\\end{itemize}\n"))
- of rnBulletItem, rnEnumItem:
- result = renderAux(d, n, disp("$1\n", "\\item $1\n"))
- of rnEnumList:
- result = renderAux(d, n, disp("$1
\n",
- "\\begin{enumerate}$1\\end{enumerate}\n"))
- of rnDefList:
- result = renderAux(d, n, disp("$1
\n",
- "\\begin{description}$1\\end{description}\n"))
- of rnDefItem: result = renderAux(d, n)
- of rnDefName: result = renderAux(d, n, disp("$1\n", "\\item[$1] "))
- of rnDefBody: result = renderAux(d, n, disp("$1\n", "$1\n"))
- of rnFieldList:
- result = nil
- for i in countup(0, len(n) - 1):
- app(result, renderRstToOut(d, n.sons[i]))
- if result != nil:
- result = dispf(
- "" &
- "" &
- "" &
- "$1" &
- "
",
- "\\begin{description}$1\\end{description}\n",
- [result])
- of rnField: result = renderField(d, n)
- of rnFieldName:
- result = renderAux(d, n, disp("$1: | ",
- "\\item[$1:]"))
- of rnFieldBody:
- result = renderAux(d, n, disp("$1 | ", " $1$n"))
- of rnIndex:
- result = renderRstToOut(d, n.sons[2])
- of rnOptionList:
- result = renderAux(d, n, disp("",
- "\\begin{description}$n$1\\end{description}\n"))
- of rnOptionListItem:
- result = renderAux(d, n, disp("$1
$n", "$1"))
- of rnOptionGroup:
- result = renderAux(d, n, disp("$1 | ", "\\item[$1]"))
- of rnDescription:
- result = renderAux(d, n, disp("$1 | $n", " $1$n"))
- of rnOption, rnOptionString, rnOptionArgument:
- InternalError("renderRstToOut")
- of rnLiteralBlock:
- result = renderAux(d, n, disp("$1
$n",
- "\\begin{rstpre}$n$1$n\\end{rstpre}$n"))
- of rnQuotedLiteralBlock:
- InternalError("renderRstToOut")
- of rnLineBlock:
- result = renderAux(d, n, disp("$1
", "$1$n$n"))
- of rnLineBlockItem:
- result = renderAux(d, n, disp("$1
", "$1\\\\$n"))
- of rnBlockQuote:
- result = renderAux(d, n, disp("$1
$n",
- "\\begin{quote}$1\\end{quote}$n"))
- of rnTable, rnGridTable:
- result = renderAux(d, n, disp(
- "",
- "\\begin{table}\\begin{rsttab}{" &
- texColumns(n) & "|}$n\\hline$n$1\\end{rsttab}\\end{table}"))
- of rnTableRow:
- if len(n) >= 1:
- result = renderRstToOut(d, n.sons[0])
- for i in countup(1, len(n) - 1):
- dispa(result, "$1", " & $1", [renderRstToOut(d, n.sons[i])])
- result = dispf("$1
$n", "$1\\\\$n\\hline$n", [result])
- else:
- result = nil
- of rnTableDataCell: result = renderAux(d, n, disp("$1 | ", "$1"))
- of rnTableHeaderCell:
- result = renderAux(d, n, disp("$1 | ", "\\textbf{$1}"))
- of rnLabel:
- InternalError("renderRstToOut") # used for footnotes and other
- of rnFootnote:
- InternalError("renderRstToOut") # a footnote
- of rnCitation:
- InternalError("renderRstToOut") # similar to footnote
- of rnRef:
- result = dispF("$1",
- "$1\\ref{$2}", [renderAux(d, n), toRope(rstnodeToRefname(n))])
- of rnStandaloneHyperlink:
- result = renderAux(d, n, disp(
- "$1",
- "\\href{$1}{$1}"))
- of rnHyperlink:
- result = dispF("$1",
- "\\href{$2}{$1}",
- [renderRstToOut(d, n.sons[0]), renderRstToOut(d, n.sons[1])])
- of rnDirArg, rnRaw: result = renderAux(d, n)
- of rnRawHtml:
- if gCmd != cmdRst2Tex:
- result = toRope(addNodes(lastSon(n)))
- of rnRawLatex:
- if gCmd == cmdRst2Tex:
- result = toRope(addNodes(lastSon(n)))
-
- of rnImage, rnFigure: result = renderImage(d, n)
- of rnCodeBlock: result = renderCodeBlock(d, n)
- of rnContainer: result = renderContainer(d, n)
- of rnSubstitutionReferences, rnSubstitutionDef:
- result = renderAux(d, n, disp("|$1|", "|$1|"))
- of rnDirective:
- result = renderAux(d, n, "") # Inline markup:
- of rnGeneralRole:
- result = dispF("$1", "\\span$2{$1}",
- [renderRstToOut(d, n.sons[0]), renderRstToOut(d, n.sons[1])])
- of rnSub: result = renderAux(d, n, disp("$1", "\\rstsub{$1}"))
- of rnSup: result = renderAux(d, n, disp("$1", "\\rstsup{$1}"))
- of rnEmphasis: result = renderAux(d, n, disp("$1", "\\emph{$1}"))
- of rnStrongEmphasis:
- result = renderAux(d, n, disp("$1", "\\textbf{$1}"))
- of rnTripleEmphasis:
- result = renderAux(d, n, disp("$1",
- "\\textbf{emph{$1}}"))
- of rnInterpretedText:
- result = renderAux(d, n, disp("$1", "\\emph{$1}"))
- of rnIdx:
- if d.theIndex == nil:
- result = renderAux(d, n, disp("$1", "\\emph{$1}"))
- else:
- result = renderIndexTerm(d, n)
- of rnInlineLiteral:
- result = renderAux(d, n, disp(
- "$1",
- "\\texttt{$1}"))
- of rnSmiley: result = renderSmiley(d, n)
- of rnLeaf: result = toRope(esc(d.target, n.text))
- of rnContents: d.hasToc = true
- of rnTitle: d.meta[metaTitle] = renderRstToOut(d, n.sons[0])
-
proc checkForFalse(n: PNode): bool =
result = n.kind == nkIdent and IdentEq(n.ident, "false")
@@ -658,56 +275,52 @@ proc genSection(d: PDoc, kind: TSymKind) =
"Iterators", "Converters", "Macros", "Templates"
]
if d.section[kind] == nil: return
- var title = toRope(sectionNames[kind])
+ var title = sectionNames[kind].toRope
d.section[kind] = ropeFormatNamedVars(getConfigVar("doc.section"), [
"sectionid", "sectionTitle", "sectionTitleID", "content"], [
- toRope(ord(kind)), title, toRope(ord(kind) + 50), d.section[kind]])
+ ord(kind).toRope, title, toRope(ord(kind) + 50), d.section[kind]])
d.toc[kind] = ropeFormatNamedVars(getConfigVar("doc.section.toc"), [
"sectionid", "sectionTitle", "sectionTitleID", "content"], [
- toRope(ord(kind)), title, toRope(ord(kind) + 50), d.toc[kind]])
+ ord(kind).toRope, title, toRope(ord(kind) + 50), d.toc[kind]])
proc genOutFile(d: PDoc): PRope =
var
- code, toc, title, content: PRope
- bodyname: string
- j: int
- j = 0
- toc = renderTocEntries(d, j, 1)
- code = nil
- content = nil
- title = nil
+ code, content: PRope = nil
+ title = ""
+ var j = 0
+ var tmp = ""
+ renderTocEntries(d[], j, 1, tmp)
+ var toc = tmp.toRope
for i in countup(low(TSymKind), high(TSymKind)):
genSection(d, i)
app(toc, d.toc[i])
- if toc != nil:
+ if toc != nil:
toc = ropeFormatNamedVars(getConfigVar("doc.toc"), ["content"], [toc])
for i in countup(low(TSymKind), high(TSymKind)): app(code, d.section[i])
- if d.meta[metaTitle] != nil: title = d.meta[metaTitle]
- else: title = toRope("Module " &
- extractFilename(changeFileExt(d.filename, "")))
- if d.hasToc: bodyname = "doc.body_toc"
- else: bodyname = "doc.body_no_toc"
+ if d.meta[metaTitle].len != 0: title = d.meta[metaTitle]
+ else: title = "Module " & extractFilename(changeFileExt(d.filename, ""))
+
+ let bodyname = if d.hasToc: "doc.body_toc" else: "doc.body_no_toc"
content = ropeFormatNamedVars(getConfigVar(bodyname), ["title",
"tableofcontents", "moduledesc", "date", "time", "content"],
- [title, toc, d.modDesc, toRope(getDateStr()),
+ [title.toRope, toc, d.modDesc, toRope(getDateStr()),
toRope(getClockStr()), code])
if optCompileOnly notin gGlobalOptions:
+ # XXX what is this hack doing here? 'optCompileOnly' means raw output!?
code = ropeFormatNamedVars(getConfigVar("doc.file"), ["title",
"tableofcontents", "moduledesc", "date", "time",
"content", "author", "version"],
- [title, toc, d.modDesc, toRope(getDateStr()),
- toRope(getClockStr()), content, d.meta[metaAuthor],
- d.meta[metaVersion]])
+ [title.toRope, toc, d.modDesc, toRope(getDateStr()),
+ toRope(getClockStr()), content, d.meta[metaAuthor].toRope,
+ d.meta[metaVersion].toRope])
else:
code = content
result = code
-proc generateIndex(d: PDoc) =
- if d.theIndex != nil:
- sortIndex(d.theIndex)
- var content = newStringOfCap(2_000_000)
- renderRstToRst(d.indexFile, content)
- writeFile(gIndexFile, content)
+proc generateIndex(d: PDoc) =
+ if optGenIndex in gGlobalOptions:
+ writeIndexFile(d[], splitFile(options.outFile).dir /
+ splitFile(d.filename).name & indexExt)
proc writeOutput(d: PDoc, filename, outExt: string) =
var content = genOutFile(d)
@@ -716,86 +329,39 @@ proc writeOutput(d: PDoc, filename, outExt: string) =
else:
writeRope(content, getOutFile(filename, outExt))
-proc CommandDoc =
+proc CommandDoc*() =
var ast = parseFile(addFileExt(gProjectFull, nimExt))
if ast == nil: return
- var d = newDocumentor(gProjectFull)
- initIndexFile(d)
+ var d = newDocumentor(gProjectFull, options.gConfigVars)
d.hasToc = true
generateDoc(d, ast)
writeOutput(d, gProjectFull, HtmlExt)
generateIndex(d)
-proc CommandRstAux(filename, outExt: string) =
+proc CommandRstAux(filename, outExt: string) =
var filen = addFileExt(filename, "txt")
- var d = newDocumentor(filen)
- initIndexFile(d)
+ var d = newDocumentor(filen, options.gConfigVars)
var rst = parseRst(readFile(filen), filen, 0, 1, d.hasToc,
{roSupportRawDirective})
- d.modDesc = renderRstToOut(d, rst)
+ d.modDesc = newMutableRope(30_000)
+ renderRstToOut(d[], rst, d.modDesc.data)
+ freezeMutableRope(d.modDesc)
writeOutput(d, filename, outExt)
generateIndex(d)
-proc CommandRst2Html =
+proc CommandRst2Html*() =
CommandRstAux(gProjectFull, HtmlExt)
-proc CommandRst2TeX =
+proc CommandRst2TeX*() =
splitter = "\\-"
CommandRstAux(gProjectFull, TexExt)
-# ---------- forum ---------------------------------------------------------
-
-proc setupConfig*() =
- msgs.gErrorMax = 1000_000
- setConfigVar("split.item.toc", "20")
- setConfigVar("doc.section", """
-
-""")
- setConfigVar("doc.section.toc", """
-
- $sectionTitle
-
-
-""")
- setConfigVar("doc.item", """
-$header
-
-$desc
-
-""")
- setConfigVar("doc.item.toc", """
- $name
-""")
- setConfigVar("doc.toc", """
-""")
- setConfigVar("doc.body_toc", """
-$tableofcontents
-
-$moduledesc
-$content
-
-""")
- setConfigVar("doc.body_no_toc", "$moduledesc $content")
- setConfigVar("doc.file", "$content")
-
-proc rstToHtml*(s: string, options: TRstParseOptions): string =
- ## exported for *nimforum*.
- const filen = "input"
- var d = newDocumentor(filen)
- d.options = options
- var dummyHasToc = false
- var rst = rstParse(s, filen, 0, 1, dummyHasToc, options)
- d.modDesc = renderRstToOut(d, rst)
- let res = genOutFile(d)
- result = res.ropeToStr
-
+proc CommandBuildIndex*() =
+ var content = mergeIndexes(gProjectFull).toRope
+
+ let code = ropeFormatNamedVars(getConfigVar("doc.file"), ["title",
+ "tableofcontents", "moduledesc", "date", "time",
+ "content", "author", "version"],
+ ["Index".toRope, nil, nil, toRope(getDateStr()),
+ toRope(getClockStr()), content, nil, nil])
+ writeRope(code, getOutFile("theindex", HtmlExt))
diff --git a/compiler/main.nim b/compiler/main.nim
index a56b12ebb7..811eb76755 100755
--- a/compiler/main.nim
+++ b/compiler/main.nim
@@ -227,7 +227,7 @@ proc MainCommand =
gCmd = cmdPretty
wantMainModule()
CommandPretty()
- of "doc":
+ of "doc":
gCmd = cmdDoc
LoadConfigs(DocConfig)
wantMainModule()
@@ -242,6 +242,10 @@ proc MainCommand =
LoadConfigs(DocTexConfig)
wantMainModule()
CommandRst2TeX()
+ of "buildindex":
+ gCmd = cmdDoc
+ LoadConfigs(DocConfig)
+ CommandBuildIndex()
of "gendepend":
gCmd = cmdGenDepend
wantMainModule()
diff --git a/compiler/options.nim b/compiler/options.nim
index 9d7b41180e..5238e839fa 100755
--- a/compiler/options.nim
+++ b/compiler/options.nim
@@ -53,7 +53,8 @@ type # please make sure we have under 32 options
optDef, # ideTools: 'def'
optThreadAnalysis, # thread analysis pass
optTaintMode, # taint mode turned on
- optTlsEmulation # thread var emulation turned on
+ optTlsEmulation, # thread var emulation turned on
+ optGenIndex # generate index file for documentation
TGlobalOptions* = set[TGlobalOption]
TCommands* = enum # Nimrod's commands
@@ -84,7 +85,6 @@ var
gExitcode*: int8
searchPaths*: TLinkedList
outFile*: string = ""
- gIndexFile*: string = ""
gCmd*: TCommands = cmdNone # the command
gVerbosity*: int # how verbose the compiler is
gNumberOfProcessors*: int # number of processors
diff --git a/compiler/ropes.nim b/compiler/ropes.nim
index b5a273e864..31ec29f0a1 100755
--- a/compiler/ropes.nim
+++ b/compiler/ropes.nim
@@ -109,6 +109,9 @@ proc newMutableRope*(capacity = 30): PRope =
new(result)
result.data = newStringOfCap(capacity)
+proc freezeMutableRope*(r: PRope) {.inline.} =
+ r.length = r.data.len
+
var
cache: array[0..2048 -1, PRope]
diff --git a/doc/advopt.txt b/doc/advopt.txt
index 876e049041..d0d711d419 100755
--- a/doc/advopt.txt
+++ b/doc/advopt.txt
@@ -4,6 +4,7 @@ Advanced commands:
//compileToOC, objc compile project to Objective C code
//rst2html convert a reStructuredText file to HTML
//rst2tex convert a reStructuredText file to TeX
+ //buildIndex build an index for the whole documentation
//run run the project (with Tiny C backend; buggy!)
//pretty pretty print the inputfile
//genDepend generate a DOT file containing the
@@ -57,7 +58,7 @@ Advanced options:
--skipParentCfg do not read the parent dirs' configuration files
--skipProjCfg do not read the project's configuration file
--gc:refc|boehm|none use Nimrod's native GC|Boehm GC|no GC
- --index:FILE use FILE to generate a documentation index file
+ --index:on|off turn index file generation on|off
--putenv:key=value set an environment variable
--listCmd list the commands used to execute external programs
--parallelBuild=0|1|... perform a parallel build
diff --git a/doc/theindex.txt b/doc/theindex.txt
deleted file mode 100755
index 2974fe6aa7..0000000000
--- a/doc/theindex.txt
+++ /dev/null
@@ -1,9665 +0,0 @@
-
-=====
-Index
-=====
-
-.. index::
-
-
- `!`:idx:
- * `macros.html#115 `_
- * `pegs.html#117 `_
-
- `!$`:idx:
- `hashes.html#103 `_
-
- `!&`:idx:
- `hashes.html#102 `_
-
- `!=`:idx:
- `system.html#368 `_
-
- `$`:idx:
- * `macros.html#116 `_
- * `sockets.html#113 `_
- * `system.html#462 `_
- * `system.html#463 `_
- * `system.html#464 `_
- * `system.html#465 `_
- * `system.html#466 `_
- * `system.html#467 `_
- * `system.html#468 `_
- * `system.html#469 `_
- * `system.html#526 `_
- * `complex.html#134 `_
- * `times.html#109 `_
- * `times.html#110 `_
- * `times.html#121 `_
- * `times.html#122 `_
- * `pegs.html#144 `_
- * `strtabs.html#115 `_
- * `smtp.html#110 `_
- * `ropes.html#119 `_
- * `xmldom.html#207 `_
- * `xmltree.html#126 `_
- * `colors.html#248 `_
- * `json.html#140 `_
- * `tables.html#116 `_
- * `tables.html#131 `_
- * `tables.html#145 `_
- * `sets.html#111 `_
- * `sets.html#121 `_
- * `lists.html#123 `_
- * `lists.html#124 `_
- * `lists.html#125 `_
- * `lists.html#126 `_
- * `intsets.html#108 `_
- * `queues.html#108 `_
- * `critbits.html#125 `_
-
- `$$`:idx:
- `marshal.html#103 `_
-
- `%`:idx:
- * `strutils.html#174 `_
- * `strutils.html#175 `_
- * `strtabs.html#114 `_
- * `ropes.html#120 `_
- * `subexes.html#111 `_
- * `subexes.html#112 `_
-
- `%%`:idx:
- * `system.html#313 `_
- * `system.html#314 `_
- * `system.html#315 `_
- * `system.html#316 `_
- * `system.html#317 `_
-
- `&`:idx:
- * `system.html#384 `_
- * `system.html#385 `_
- * `system.html#386 `_
- * `system.html#387 `_
- * `system.html#510 `_
- * `system.html#511 `_
- * `system.html#512 `_
- * `pegs.html#116 `_
- * `ropes.html#109 `_
- * `ropes.html#110 `_
- * `ropes.html#111 `_
- * `ropes.html#112 `_
-
- `&=`:idx:
- `system.html#628 `_
-
- `*`:idx:
- * `system.html#233 `_
- * `system.html#234 `_
- * `system.html#235 `_
- * `system.html#236 `_
- * `system.html#237 `_
- * `system.html#332 `_
- * `system.html#340 `_
- * `algorithm.html#102 `_
- * `complex.html#114 `_
- * `complex.html#115 `_
- * `complex.html#116 `_
- * `pegs.html#112 `_
-
- `*%`:idx:
- * `system.html#303 `_
- * `system.html#304 `_
- * `system.html#305 `_
- * `system.html#306 `_
- * `system.html#307 `_
-
- `*=`:idx:
- * `system.html#623 `_
- * `system.html#626 `_
-
- `+`:idx:
- * `system.html#208 `_
- * `system.html#209 `_
- * `system.html#210 `_
- * `system.html#211 `_
- * `system.html#212 `_
- * `system.html#223 `_
- * `system.html#224 `_
- * `system.html#225 `_
- * `system.html#226 `_
- * `system.html#227 `_
- * `system.html#328 `_
- * `system.html#330 `_
- * `system.html#341 `_
- * `complex.html#104 `_
- * `complex.html#105 `_
- * `complex.html#106 `_
- * `pegs.html#115 `_
- * `colors.html#103 `_
-
- `+%`:idx:
- * `system.html#293 `_
- * `system.html#294 `_
- * `system.html#295 `_
- * `system.html#296 `_
- * `system.html#297 `_
-
- `+=`:idx:
- * `system.html#621 `_
- * `system.html#624 `_
-
- `-`:idx:
- * `system.html#213 `_
- * `system.html#214 `_
- * `system.html#215 `_
- * `system.html#216 `_
- * `system.html#217 `_
- * `system.html#228 `_
- * `system.html#229 `_
- * `system.html#230 `_
- * `system.html#231 `_
- * `system.html#232 `_
- * `system.html#329 `_
- * `system.html#331 `_
- * `system.html#342 `_
- * `complex.html#107 `_
- * `complex.html#108 `_
- * `complex.html#109 `_
- * `complex.html#110 `_
- * `times.html#111 `_
- * `colors.html#104 `_
-
- `-%`:idx:
- * `system.html#298 `_
- * `system.html#299 `_
- * `system.html#300 `_
- * `system.html#301 `_
- * `system.html#302 `_
-
- `-+-`:idx:
- `system.html#343 `_
-
- `-=`:idx:
- * `system.html#622 `_
- * `system.html#625 `_
-
- `..`:idx:
- * `system.html#141 `_
- * `system.html#143 `_
- * `system.html#481 `_
-
- `/`:idx:
- * `system.html#333 `_
- * `system.html#607 `_
- * `os.html#128 `_
- * `complex.html#111 `_
- * `complex.html#112 `_
- * `complex.html#113 `_
- * `pegs.html#109 `_
-
- `/%`:idx:
- * `system.html#308 `_
- * `system.html#309 `_
- * `system.html#310 `_
- * `system.html#311 `_
- * `system.html#312 `_
-
- `/../`:idx:
- `os.html#133 `_
-
- `/=`:idx:
- `system.html#627 `_
-
- `<`:idx:
- * `system.html#183 `_
- * `system.html#283 `_
- * `system.html#284 `_
- * `system.html#285 `_
- * `system.html#286 `_
- * `system.html#287 `_
- * `system.html#336 `_
- * `system.html#360 `_
- * `system.html#361 `_
- * `system.html#362 `_
- * `system.html#363 `_
- * `system.html#364 `_
- * `system.html#365 `_
- * `system.html#366 `_
- * `system.html#367 `_
- * `system.html#525 `_
- * `times.html#112 `_
-
- `<%`:idx:
- `unicode.html#104 `_
-
- `<%`:idx:
- * `system.html#323 `_
- * `system.html#324 `_
- * `system.html#325 `_
- * `system.html#326 `_
- * `system.html#327 `_
-
- `<=`:idx:
- `times.html#113 `_
-
- `<=`:idx:
- * `system.html#278 `_
- * `system.html#279 `_
- * `system.html#280 `_
- * `system.html#281 `_
- * `system.html#282 `_
- * `system.html#335 `_
- * `system.html#353 `_
- * `system.html#354 `_
- * `system.html#355 `_
- * `system.html#356 `_
- * `system.html#357 `_
- * `system.html#358 `_
- * `system.html#359 `_
- * `system.html#524 `_
-
- `<=%`:idx:
- * `system.html#318 `_
- * `system.html#319 `_
- * `system.html#320 `_
- * `system.html#321 `_
- * `system.html#322 `_
-
- `<=%`:idx:
- `unicode.html#103 `_
-
- `<>`:idx:
- `xmltree.html#128 `_
-
- `==`:idx:
- * `md5.html#107 `_
- * `macros.html#117 `_
- * `macros.html#118 `_
- * `sockets.html#111 `_
- * `sockets.html#112 `_
- * `system.html#273 `_
- * `system.html#274 `_
- * `system.html#275 `_
- * `system.html#276 `_
- * `system.html#277 `_
- * `system.html#334 `_
- * `system.html#344 `_
- * `system.html#345 `_
- * `system.html#346 `_
- * `system.html#347 `_
- * `system.html#348 `_
- * `system.html#349 `_
- * `system.html#350 `_
- * `system.html#351 `_
- * `system.html#352 `_
- * `system.html#513 `_
- * `system.html#523 `_
- * `complex.html#102 `_
- * `unicode.html#105 `_
- * `colors.html#102 `_
-
- `=~`:idx:
- `pegs.html#157 `_
-
- `=~`:idx:
- `regexprs.html#111 `_
-
- `=~`:idx:
- `re.html#120 `_
-
- `=~`:idx:
- `complex.html#103 `_
-
- `>`:idx:
- `system.html#370 `_
-
- `>%`:idx:
- `system.html#461 `_
-
- `>=`:idx:
- `system.html#369 `_
-
- `>=%`:idx:
- `system.html#460 `_
-
- `?`:idx:
- `pegs.html#111 `_
-
- `@`:idx:
- * `system.html#379 `_
- * `pegs.html#113 `_
-
- `@@`:idx:
- `pegs.html#114 `_
-
- `[]`:idx:
- `macros.html#113 `_
-
- `[]`:idx:
- * `json.html#130 `_
- * `json.html#131 `_
-
- `[]`:idx:
- * `tables.html#108 `_
- * `tables.html#124 `_
- * `tables.html#139 `_
-
- `[]`:idx:
- * `system.html#608 `_
- * `system.html#611 `_
- * `system.html#613 `_
- * `system.html#615 `_
-
- `[]`:idx:
- * `typeinfo.html#112 `_
- * `typeinfo.html#120 `_
- * `typeinfo.html#121 `_
-
- `[]`:idx:
- * `graphics.html#116 `_
- * `graphics.html#117 `_
-
- `[]`:idx:
- `strtabs.html#107 `_
-
- `[]`:idx:
- `ropes.html#115 `_
-
- `[]`:idx:
- `critbits.html#110