Mercurial > projects > dil

annotate trunk/src/cmd/DDoc.d @ 778:78be32e3e157

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Implemented conditional compilation.
author Aziz K?ksal <aziz.koeksal@gmail.com>
date Wed, 20 Feb 2008 22:09:29 +0100
parents 9f61e8af55d5
children 8e6fed11bb68
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
731
ca7607226caa Added new module cmd.DDoc.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents:
diff changeset
1 /++
ca7607226caa Added new module cmd.DDoc.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents:
diff changeset
2 Author: Aziz Köksal
ca7607226caa Added new module cmd.DDoc.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents:
diff changeset
3 License: GPL3
ca7607226caa Added new module cmd.DDoc.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents:
diff changeset
4 +/
ca7607226caa Added new module cmd.DDoc.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents:
diff changeset
5 module cmd.DDoc;
ca7607226caa Added new module cmd.DDoc.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents:
diff changeset
6
761
307905dadf5d DDoc code sections are highlighted now.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 754
diff changeset
7 import cmd.Generate;
731
ca7607226caa Added new module cmd.DDoc.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents:
diff changeset
8 import dil.doc.Parser;
ca7607226caa Added new module cmd.DDoc.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents:
diff changeset
9 import dil.doc.Macro;
ca7607226caa Added new module cmd.DDoc.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents:
diff changeset
10 import dil.doc.Doc;
737
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
11 import dil.ast.Node;
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
12 import dil.ast.Declarations,
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
13 dil.ast.Statements,
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
14 dil.ast.Expression,
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
15 dil.ast.Parameters,
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
16 dil.ast.Types;
731
ca7607226caa Added new module cmd.DDoc.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents:
diff changeset
17 import dil.ast.DefaultVisitor;
737
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
18 import dil.lexer.Token;
747
00f872d949ea Added method scanCommentText() to DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 744
diff changeset
19 import dil.lexer.Funcs;
731
ca7607226caa Added new module cmd.DDoc.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents:
diff changeset
20 import dil.semantic.Module;
ca7607226caa Added new module cmd.DDoc.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents:
diff changeset
21 import dil.semantic.Pass1;
ca7607226caa Added new module cmd.DDoc.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents:
diff changeset
22 import dil.semantic.Symbol;
ca7607226caa Added new module cmd.DDoc.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents:
diff changeset
23 import dil.semantic.Symbols;
778
78be32e3e157 Implemented conditional compilation.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 777
diff changeset
24 import dil.Compilation;
731
ca7607226caa Added new module cmd.DDoc.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents:
diff changeset
25 import dil.Information;
739
49fe21aa387c Added sanitizeText() to dil.Converter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 737
diff changeset
26 import dil.Converter;
764
4579e8505d5e Fixed unittests and removed dil.File.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 761
diff changeset
27 import dil.SourceText;
775
e76c9fdb83a3 DDocEmitter emits declaration attributes now.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 773
diff changeset
28 import dil.Enums;
776
580d4ca9f1ff Added new module dil.Time.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 775
diff changeset
29 import dil.Time;
731
ca7607226caa Added new module cmd.DDoc.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents:
diff changeset
30 import common;
ca7607226caa Added new module cmd.DDoc.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents:
diff changeset
31
737
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
32 import tango.text.Ascii : toUpper;
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
33 import tango.io.File;
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
34 import tango.io.FilePath;
731
ca7607226caa Added new module cmd.DDoc.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents:
diff changeset
35
ca7607226caa Added new module cmd.DDoc.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents:
diff changeset
36 void execute(string[] filePaths, string destDir, string[] macroPaths,
778
78be32e3e157 Implemented conditional compilation.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 777
diff changeset
37 bool incUndoc, bool verbose, CompilationContext context,
78be32e3e157 Implemented conditional compilation.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 777
diff changeset
38 InfoManager infoMan)
731
ca7607226caa Added new module cmd.DDoc.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents:
diff changeset
39 {
ca7607226caa Added new module cmd.DDoc.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents:
diff changeset
40 // Parse macro files.
ca7607226caa Added new module cmd.DDoc.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents:
diff changeset
41 MacroTable mtable;
ca7607226caa Added new module cmd.DDoc.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents:
diff changeset
42 MacroParser mparser;
ca7607226caa Added new module cmd.DDoc.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents:
diff changeset
43 foreach (macroPath; macroPaths)
ca7607226caa Added new module cmd.DDoc.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents:
diff changeset
44 {
764
4579e8505d5e Fixed unittests and removed dil.File.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 761
diff changeset
45 auto macros = mparser.parse(loadMacroFile(macroPath, infoMan));
731
ca7607226caa Added new module cmd.DDoc.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents:
diff changeset
46 mtable = new MacroTable(mtable);
ca7607226caa Added new module cmd.DDoc.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents:
diff changeset
47 mtable.insert(macros);
ca7607226caa Added new module cmd.DDoc.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents:
diff changeset
48 }
ca7607226caa Added new module cmd.DDoc.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents:
diff changeset
49
ca7607226caa Added new module cmd.DDoc.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents:
diff changeset
50 // foreach (k, v; mtable.table)
ca7607226caa Added new module cmd.DDoc.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents:
diff changeset
51 // Stdout(k)("=")(v.text);
ca7607226caa Added new module cmd.DDoc.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents:
diff changeset
52
761
307905dadf5d DDoc code sections are highlighted now.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 754
diff changeset
53 auto tokenHL = new TokenHighlighter(infoMan); // For DDoc code sections.
307905dadf5d DDoc code sections are highlighted now.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 754
diff changeset
54
307905dadf5d DDoc code sections are highlighted now.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 754
diff changeset
55 // Process D files.
731
ca7607226caa Added new module cmd.DDoc.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents:
diff changeset
56 foreach (filePath; filePaths)
ca7607226caa Added new module cmd.DDoc.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents:
diff changeset
57 {
ca7607226caa Added new module cmd.DDoc.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents:
diff changeset
58 auto mod = new Module(filePath, infoMan);
ca7607226caa Added new module cmd.DDoc.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents:
diff changeset
59 // Parse the file.
ca7607226caa Added new module cmd.DDoc.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents:
diff changeset
60 mod.parse();
ca7607226caa Added new module cmd.DDoc.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents:
diff changeset
61 if (mod.hasErrors)
ca7607226caa Added new module cmd.DDoc.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents:
diff changeset
62 continue;
ca7607226caa Added new module cmd.DDoc.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents:
diff changeset
63
ca7607226caa Added new module cmd.DDoc.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents:
diff changeset
64 // Start semantic analysis.
778
78be32e3e157 Implemented conditional compilation.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 777
diff changeset
65 auto pass1 = new SemanticPass1(mod, context);
731
ca7607226caa Added new module cmd.DDoc.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents:
diff changeset
66 pass1.start();
737
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
67
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
68 // Generate documentation.
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
69 auto dest = new FilePath(destDir);
742
fc8f0e61bc42 Fixed building of time_str.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 741
diff changeset
70 dest.append(mod.getFQN() ~ ".html");
751
8caf18892c1b Improved DDocEmitter and fixed bugs.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 747
diff changeset
71
744
7173ece1b696 Wrapped some macro functions inside struct MacroExpander.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 743
diff changeset
72 InfoManager infoMan2; // Collects warnings from the macro expander.
742
fc8f0e61bc42 Fixed building of time_str.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 741
diff changeset
73 if (verbose)
744
7173ece1b696 Wrapped some macro functions inside struct MacroExpander.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 743
diff changeset
74 {
742
fc8f0e61bc42 Fixed building of time_str.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 741
diff changeset
75 Stdout.formatln("{} > {}", mod.filePath, dest);
744
7173ece1b696 Wrapped some macro functions inside struct MacroExpander.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 743
diff changeset
76 infoMan2 = new InfoManager();
7173ece1b696 Wrapped some macro functions inside struct MacroExpander.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 743
diff changeset
77 }
751
8caf18892c1b Improved DDocEmitter and fixed bugs.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 747
diff changeset
78
761
307905dadf5d DDoc code sections are highlighted now.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 754
diff changeset
79 writeDocFile(dest.toString(), mod, mtable, incUndoc, tokenHL, infoMan2);
751
8caf18892c1b Improved DDocEmitter and fixed bugs.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 747
diff changeset
80
744
7173ece1b696 Wrapped some macro functions inside struct MacroExpander.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 743
diff changeset
81 if (infoMan2)
7173ece1b696 Wrapped some macro functions inside struct MacroExpander.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 743
diff changeset
82 infoMan ~= infoMan2.info;
731
ca7607226caa Added new module cmd.DDoc.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents:
diff changeset
83 }
ca7607226caa Added new module cmd.DDoc.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents:
diff changeset
84 }
ca7607226caa Added new module cmd.DDoc.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents:
diff changeset
85
744
7173ece1b696 Wrapped some macro functions inside struct MacroExpander.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 743
diff changeset
86 void writeDocFile(string dest, Module mod, MacroTable mtable, bool incUndoc,
761
307905dadf5d DDoc code sections are highlighted now.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 754
diff changeset
87 TokenHighlighter tokenHL, InfoManager infoMan)
731
ca7607226caa Added new module cmd.DDoc.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents:
diff changeset
88 {
ca7607226caa Added new module cmd.DDoc.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents:
diff changeset
89 // Create a macro environment for this module.
ca7607226caa Added new module cmd.DDoc.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents:
diff changeset
90 mtable = new MacroTable(mtable);
ca7607226caa Added new module cmd.DDoc.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents:
diff changeset
91 // Define runtime macros.
776
580d4ca9f1ff Added new module dil.Time.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 775
diff changeset
92 mtable.insert("MODPATH", mod.getFQNPath() ~ mod.fileExtension());
580d4ca9f1ff Added new module dil.Time.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 775
diff changeset
93
737
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
94 mtable.insert("TITLE", mod.getFQN());
777
9f61e8af55d5 Added module dil.Compilation.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 776
diff changeset
95 mtable.insert("DOCFILENAME", mod.getFQN() ~ ".html");
776
580d4ca9f1ff Added new module dil.Time.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 775
diff changeset
96 auto timeStr = Time.toString();
580d4ca9f1ff Added new module dil.Time.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 775
diff changeset
97 mtable.insert("DATETIME", timeStr);
777
9f61e8af55d5 Added module dil.Compilation.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 776
diff changeset
98 mtable.insert("YEAR", Time.year(timeStr));
731
ca7607226caa Added new module cmd.DDoc.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents:
diff changeset
99
761
307905dadf5d DDoc code sections are highlighted now.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 754
diff changeset
100 auto doc = new DDocEmitter(mtable, incUndoc, mod, tokenHL);
307905dadf5d DDoc code sections are highlighted now.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 754
diff changeset
101 doc.emit();
737
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
102 // Set BODY macro to the text produced by the DDocEmitter.
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
103 mtable.insert("BODY", doc.text);
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
104 // Do the macro expansion pass.
744
7173ece1b696 Wrapped some macro functions inside struct MacroExpander.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 743
diff changeset
105 auto fileText = MacroExpander.expand(mtable, "$(DDOC)", mod.filePath, infoMan);
751
8caf18892c1b Improved DDocEmitter and fixed bugs.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 747
diff changeset
106 // fileText ~= "\n<pre>\n" ~ doc.text ~ "\n</pre>";
737
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
107 // Finally write the file out to the harddisk.
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
108 auto file = new File(dest);
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
109 file.write(fileText);
731
ca7607226caa Added new module cmd.DDoc.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents:
diff changeset
110 }
ca7607226caa Added new module cmd.DDoc.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents:
diff changeset
111
764
4579e8505d5e Fixed unittests and removed dil.File.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 761
diff changeset
112 string loadMacroFile(string filePath, InfoManager infoMan)
739
49fe21aa387c Added sanitizeText() to dil.Converter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 737
diff changeset
113 {
764
4579e8505d5e Fixed unittests and removed dil.File.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 761
diff changeset
114 auto src = new SourceText(filePath);
4579e8505d5e Fixed unittests and removed dil.File.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 761
diff changeset
115 src.load(infoMan);
765
bc812843603c Template functions are wrapped inside TemplateDeclarations now.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 764
diff changeset
116 auto text = src.data[0..$-1]; // Exclude '\0'.
bc812843603c Template functions are wrapped inside TemplateDeclarations now.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 764
diff changeset
117 return sanitizeText(text);
739
49fe21aa387c Added sanitizeText() to dil.Converter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 737
diff changeset
118 }
49fe21aa387c Added sanitizeText() to dil.Converter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 737
diff changeset
119
737
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
120 /// Traverses the syntax tree and writes DDoc macros to a string buffer.
731
ca7607226caa Added new module cmd.DDoc.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents:
diff changeset
121 class DDocEmitter : DefaultVisitor
ca7607226caa Added new module cmd.DDoc.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents:
diff changeset
122 {
ca7607226caa Added new module cmd.DDoc.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents:
diff changeset
123 char[] text;
737
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
124 bool includeUndocumented;
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
125 MacroTable mtable;
761
307905dadf5d DDoc code sections are highlighted now.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 754
diff changeset
126 Module modul;
307905dadf5d DDoc code sections are highlighted now.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 754
diff changeset
127 TokenHighlighter tokenHL;
731
ca7607226caa Added new module cmd.DDoc.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents:
diff changeset
128
761
307905dadf5d DDoc code sections are highlighted now.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 754
diff changeset
129 this(MacroTable mtable, bool includeUndocumented, Module modul,
307905dadf5d DDoc code sections are highlighted now.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 754
diff changeset
130 TokenHighlighter tokenHL)
737
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
131 {
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
132 this.mtable = mtable;
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
133 this.includeUndocumented = includeUndocumented;
761
307905dadf5d DDoc code sections are highlighted now.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 754
diff changeset
134 this.modul = modul;
307905dadf5d DDoc code sections are highlighted now.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 754
diff changeset
135 this.tokenHL = tokenHL;
737
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
136 }
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
137
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
138 /// Entry method.
761
307905dadf5d DDoc code sections are highlighted now.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 754
diff changeset
139 char[] emit()
731
ca7607226caa Added new module cmd.DDoc.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents:
diff changeset
140 {
761
307905dadf5d DDoc code sections are highlighted now.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 754
diff changeset
141 if (auto d = modul.moduleDecl)
737
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
142 {
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
143 if (ddoc(d))
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
144 {
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
145 if (auto copyright = cmnt.takeCopyright())
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
146 mtable.insert(new Macro("COPYRIGHT", copyright.text));
773
6dbbb403fc58 Improved the DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 772
diff changeset
147 DESC({
6dbbb403fc58 Improved the DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 772
diff changeset
148 writeComment();
6dbbb403fc58 Improved the DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 772
diff changeset
149 MEMBERS("MODULE", { visitD(modul.root); });
6dbbb403fc58 Improved the DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 772
diff changeset
150 });
737
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
151 }
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
152 }
773
6dbbb403fc58 Improved the DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 772
diff changeset
153 else
6dbbb403fc58 Improved the DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 772
diff changeset
154 MEMBERS("MODULE", { visitD(modul.root); });
731
ca7607226caa Added new module cmd.DDoc.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents:
diff changeset
155 return text;
ca7607226caa Added new module cmd.DDoc.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents:
diff changeset
156 }
737
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
157
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
158 char[] textSpan(Token* left, Token* right)
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
159 {
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
160 //assert(left && right && (left.end <= right.start || left is right));
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
161 //char[] result;
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
162 //TODO: filter out whitespace tokens.
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
163 return Token.textSpan(left, right);
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
164 }
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
165
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
166 TemplateParameters tparams; /// The template parameters of the declaration.
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
167
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
168 DDocComment cmnt; /// Current comment.
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
169 DDocComment prevCmnt; /// Previous comment in scope.
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
170 /// An empty comment. Used for undocumented symbols.
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
171 static const DDocComment emptyCmnt;
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
172
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
173 static this()
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
174 {
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
175 this.emptyCmnt = new DDocComment(null, null, null);
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
176 }
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
177
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
178 /// Keeps track of previous comments in each scope.
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
179 scope class Scope
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
180 {
751
8caf18892c1b Improved DDocEmitter and fixed bugs.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 747
diff changeset
181 DDocComment saved_prevCmnt;
8caf18892c1b Improved DDocEmitter and fixed bugs.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 747
diff changeset
182 bool saved_cmntIsDitto;
8caf18892c1b Improved DDocEmitter and fixed bugs.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 747
diff changeset
183 uint saved_prevDeclOffset;
737
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
184 this()
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
185 { // Save the previous comment of the parent scope.
751
8caf18892c1b Improved DDocEmitter and fixed bugs.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 747
diff changeset
186 saved_prevCmnt = this.outer.prevCmnt;
8caf18892c1b Improved DDocEmitter and fixed bugs.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 747
diff changeset
187 saved_cmntIsDitto = this.outer.cmntIsDitto;
8caf18892c1b Improved DDocEmitter and fixed bugs.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 747
diff changeset
188 saved_prevDeclOffset = this.outer.prevDeclOffset;
8caf18892c1b Improved DDocEmitter and fixed bugs.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 747
diff changeset
189 // Entering a new scope. Clear variables.
737
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
190 this.outer.prevCmnt = null;
751
8caf18892c1b Improved DDocEmitter and fixed bugs.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 747
diff changeset
191 this.outer.cmntIsDitto = false;
8caf18892c1b Improved DDocEmitter and fixed bugs.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 747
diff changeset
192 this.outer.prevDeclOffset = 0;
737
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
193 }
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
194
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
195 ~this()
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
196 { // Restore the previous comment of the parent scope.
751
8caf18892c1b Improved DDocEmitter and fixed bugs.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 747
diff changeset
197 this.outer.prevCmnt = saved_prevCmnt;
8caf18892c1b Improved DDocEmitter and fixed bugs.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 747
diff changeset
198 this.outer.cmntIsDitto = saved_cmntIsDitto;
8caf18892c1b Improved DDocEmitter and fixed bugs.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 747
diff changeset
199 this.outer.prevDeclOffset = saved_prevDeclOffset;
737
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
200 }
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
201 }
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
202
751
8caf18892c1b Improved DDocEmitter and fixed bugs.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 747
diff changeset
203 bool cmntIsDitto;
8caf18892c1b Improved DDocEmitter and fixed bugs.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 747
diff changeset
204
737
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
205 DDocComment ddoc(Node node)
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
206 {
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
207 auto c = getDDocComment(node);
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
208 this.cmnt = null;
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
209 if (c)
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
210 {
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
211 if (c.isDitto)
751
8caf18892c1b Improved DDocEmitter and fixed bugs.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 747
diff changeset
212 {
737
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
213 this.cmnt = this.prevCmnt;
751
8caf18892c1b Improved DDocEmitter and fixed bugs.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 747
diff changeset
214 this.cmntIsDitto = true;
8caf18892c1b Improved DDocEmitter and fixed bugs.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 747
diff changeset
215 }
737
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
216 else
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
217 {
751
8caf18892c1b Improved DDocEmitter and fixed bugs.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 747
diff changeset
218 this.cmntIsDitto = false;
737
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
219 this.cmnt = c;
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
220 this.prevCmnt = c;
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
221 }
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
222 }
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
223 else if (includeUndocumented)
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
224 this.cmnt = this.emptyCmnt;
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
225 return this.cmnt;
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
226 }
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
227
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
228 static char[][char[]] specialSections;
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
229 static this()
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
230 {
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
231 foreach (name; ["AUTHORS", "BUGS", "COPYRIGHT", "DATE", "DEPRECATED",
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
232 "EXAMPLES", "HISTORY", "LICENSE", "RETURNS", "SEE_ALSO",
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
233 "STANDARDS", "THROWS", "VERSION"])
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
234 specialSections[name] = name;
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
235 }
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
236
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
237 void writeComment()
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
238 {
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
239 auto c = this.cmnt;
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
240 assert(c !is null);
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
241 if (c.sections.length == 0)
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
242 return;
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
243 write("$(DDOC_SECTIONS ");
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
244 foreach (s; c.sections)
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
245 {
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
246 if (s is c.summary)
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
247 write("\n$(DDOC_SUMMARY ");
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
248 else if (s is c.description)
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
249 write("\n$(DDOC_DESCRIPTION ");
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
250 else if (auto name = toUpper(s.name.dup) in specialSections)
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
251 write("\n$(DDOC_" ~ *name ~ " ");
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
252 else if (s.Is("params"))
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
253 { // Process parameters section.
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
254 auto ps = new ParamsSection(s.name, s.text);
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
255 write("\n$(DDOC_PARAMS ");
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
256 foreach (i, paramName; ps.paramNames)
741
35184354a502 Added method textBody() to IdentValueParser.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 740
diff changeset
257 write("\n$(DDOC_PARAM_ROW ",
751
8caf18892c1b Improved DDocEmitter and fixed bugs.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 747
diff changeset
258 "$(DDOC_PARAM_ID $(DDOC_PARAM ", paramName, "))",
737
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
259 "$(DDOC_PARAM_DESC ", ps.paramDescs[i], ")",
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
260 ")");
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
261 write(")");
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
262 continue;
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
263 }
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
264 else if (s.Is("macros"))
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
265 { // Declare the macros in this section.
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
266 auto ms = new MacrosSection(s.name, s.text);
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
267 mtable.insert(ms.macroNames, ms.macroTexts);
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
268 continue;
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
269 }
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
270 else
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
271 write("\n$(DDOC_SECTION $(DDOC_SECTION_H " ~ s.name ~ ":)");
747
00f872d949ea Added method scanCommentText() to DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 744
diff changeset
272 write(scanCommentText(s.text), ")");
737
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
273 }
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
274 write(")");
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
275 }
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
276
747
00f872d949ea Added method scanCommentText() to DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 744
diff changeset
277 char[] scanCommentText(char[] text)
00f872d949ea Added method scanCommentText() to DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 744
diff changeset
278 {
00f872d949ea Added method scanCommentText() to DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 744
diff changeset
279 char* p = text.ptr;
00f872d949ea Added method scanCommentText() to DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 744
diff changeset
280 char* end = p + text.length;
00f872d949ea Added method scanCommentText() to DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 744
diff changeset
281 char[] result = new char[text.length]; // Reserve space.
00f872d949ea Added method scanCommentText() to DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 744
diff changeset
282 result.length = 0;
00f872d949ea Added method scanCommentText() to DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 744
diff changeset
283
00f872d949ea Added method scanCommentText() to DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 744
diff changeset
284 while (p < end)
00f872d949ea Added method scanCommentText() to DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 744
diff changeset
285 {
00f872d949ea Added method scanCommentText() to DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 744
diff changeset
286 switch (*p)
00f872d949ea Added method scanCommentText() to DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 744
diff changeset
287 {
00f872d949ea Added method scanCommentText() to DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 744
diff changeset
288 case '$':
00f872d949ea Added method scanCommentText() to DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 744
diff changeset
289 if (auto macroEnd = MacroParser.scanMacro(p, end))
00f872d949ea Added method scanCommentText() to DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 744
diff changeset
290 {
00f872d949ea Added method scanCommentText() to DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 744
diff changeset
291 result ~= makeString(p, macroEnd); // Copy macro invocation as is.
00f872d949ea Added method scanCommentText() to DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 744
diff changeset
292 p = macroEnd;
00f872d949ea Added method scanCommentText() to DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 744
diff changeset
293 continue;
00f872d949ea Added method scanCommentText() to DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 744
diff changeset
294 }
00f872d949ea Added method scanCommentText() to DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 744
diff changeset
295 goto default;
00f872d949ea Added method scanCommentText() to DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 744
diff changeset
296 case '<':
00f872d949ea Added method scanCommentText() to DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 744
diff changeset
297 auto begin = p;
00f872d949ea Added method scanCommentText() to DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 744
diff changeset
298 p++;
00f872d949ea Added method scanCommentText() to DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 744
diff changeset
299 if (p+2 < end && *p == '!' && p[1] == '-' && p[2] == '-') // <!--
00f872d949ea Added method scanCommentText() to DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 744
diff changeset
300 {
00f872d949ea Added method scanCommentText() to DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 744
diff changeset
301 p += 2; // Point to 2nd '-'.
00f872d949ea Added method scanCommentText() to DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 744
diff changeset
302 // Scan to closing "-->".
00f872d949ea Added method scanCommentText() to DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 744
diff changeset
303 while (++p < end)
00f872d949ea Added method scanCommentText() to DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 744
diff changeset
304 if (p+2 < end && *p == '-' && p[1] == '-' && p[2] == '>')
00f872d949ea Added method scanCommentText() to DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 744
diff changeset
305 {
00f872d949ea Added method scanCommentText() to DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 744
diff changeset
306 p += 3; // Point one past '>'.
00f872d949ea Added method scanCommentText() to DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 744
diff changeset
307 break;
00f872d949ea Added method scanCommentText() to DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 744
diff changeset
308 }
00f872d949ea Added method scanCommentText() to DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 744
diff changeset
309 result ~= makeString(begin, p);
00f872d949ea Added method scanCommentText() to DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 744
diff changeset
310 } // <tag ...> or </tag>
00f872d949ea Added method scanCommentText() to DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 744
diff changeset
311 else if (p < end && (isalpha(*p) || *p == '/'))
00f872d949ea Added method scanCommentText() to DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 744
diff changeset
312 {
00f872d949ea Added method scanCommentText() to DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 744
diff changeset
313 while (++p < end && *p != '>') // Skip to closing '>'.
00f872d949ea Added method scanCommentText() to DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 744
diff changeset
314 {}
751
8caf18892c1b Improved DDocEmitter and fixed bugs.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 747
diff changeset
315 if (p == end)
8caf18892c1b Improved DDocEmitter and fixed bugs.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 747
diff changeset
316 { // No closing '>' found.
8caf18892c1b Improved DDocEmitter and fixed bugs.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 747
diff changeset
317 p = begin + 1;
8caf18892c1b Improved DDocEmitter and fixed bugs.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 747
diff changeset
318 result ~= "&lt;";
8caf18892c1b Improved DDocEmitter and fixed bugs.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 747
diff changeset
319 continue;
8caf18892c1b Improved DDocEmitter and fixed bugs.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 747
diff changeset
320 }
8caf18892c1b Improved DDocEmitter and fixed bugs.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 747
diff changeset
321 p++; // Skip '>'.
747
00f872d949ea Added method scanCommentText() to DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 744
diff changeset
322 result ~= makeString(begin, p);
00f872d949ea Added method scanCommentText() to DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 744
diff changeset
323 }
00f872d949ea Added method scanCommentText() to DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 744
diff changeset
324 else
00f872d949ea Added method scanCommentText() to DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 744
diff changeset
325 result ~= "&lt;";
00f872d949ea Added method scanCommentText() to DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 744
diff changeset
326 continue;
00f872d949ea Added method scanCommentText() to DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 744
diff changeset
327 case '(': result ~= "&#40;"; break;
00f872d949ea Added method scanCommentText() to DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 744
diff changeset
328 case ')': result ~= "&#41;"; break;
751
8caf18892c1b Improved DDocEmitter and fixed bugs.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 747
diff changeset
329 // case '\'': result ~= "&apos;"; break; // &#39;
8caf18892c1b Improved DDocEmitter and fixed bugs.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 747
diff changeset
330 // case '"': result ~= "&quot;"; break;
747
00f872d949ea Added method scanCommentText() to DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 744
diff changeset
331 case '>': result ~= "&gt;"; break;
00f872d949ea Added method scanCommentText() to DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 744
diff changeset
332 case '&':
00f872d949ea Added method scanCommentText() to DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 744
diff changeset
333 if (p+1 < end && (isalpha(p[1]) || p[1] == '#'))
00f872d949ea Added method scanCommentText() to DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 744
diff changeset
334 goto default;
00f872d949ea Added method scanCommentText() to DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 744
diff changeset
335 result ~= "&amp;";
00f872d949ea Added method scanCommentText() to DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 744
diff changeset
336 break;
754
c7a5499faa77 Improved DDoc related code.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 751
diff changeset
337 case '\n':
c7a5499faa77 Improved DDoc related code.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 751
diff changeset
338 if (!(p+1 < end && p[1] == '\n'))
c7a5499faa77 Improved DDoc related code.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 751
diff changeset
339 goto default;
c7a5499faa77 Improved DDoc related code.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 751
diff changeset
340 ++p;
c7a5499faa77 Improved DDoc related code.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 751
diff changeset
341 result ~= "$(DDOC_BLANKLINE)";
c7a5499faa77 Improved DDoc related code.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 751
diff changeset
342 break;
747
00f872d949ea Added method scanCommentText() to DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 744
diff changeset
343 case '-':
00f872d949ea Added method scanCommentText() to DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 744
diff changeset
344 if (p+2 < end && p[1] == '-' && p[2] == '-')
00f872d949ea Added method scanCommentText() to DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 744
diff changeset
345 {
751
8caf18892c1b Improved DDocEmitter and fixed bugs.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 747
diff changeset
346 while (p < end && *p == '-')
8caf18892c1b Improved DDocEmitter and fixed bugs.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 747
diff changeset
347 p++;
8caf18892c1b Improved DDocEmitter and fixed bugs.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 747
diff changeset
348 auto codeBegin = p;
8caf18892c1b Improved DDocEmitter and fixed bugs.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 747
diff changeset
349 p--;
747
00f872d949ea Added method scanCommentText() to DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 744
diff changeset
350 while (++p < end)
00f872d949ea Added method scanCommentText() to DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 744
diff changeset
351 if (p+2 < end && *p == '-' && p[1] == '-' && p[2] == '-')
00f872d949ea Added method scanCommentText() to DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 744
diff changeset
352 break;
761
307905dadf5d DDoc code sections are highlighted now.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 754
diff changeset
353 auto codeText = makeString(codeBegin, p);
307905dadf5d DDoc code sections are highlighted now.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 754
diff changeset
354 result ~= tokenHL.highlight(codeText, modul.filePath);
751
8caf18892c1b Improved DDocEmitter and fixed bugs.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 747
diff changeset
355 while (p < end && *p == '-')
8caf18892c1b Improved DDocEmitter and fixed bugs.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 747
diff changeset
356 p++;
747
00f872d949ea Added method scanCommentText() to DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 744
diff changeset
357 continue;
00f872d949ea Added method scanCommentText() to DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 744
diff changeset
358 }
00f872d949ea Added method scanCommentText() to DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 744
diff changeset
359 //goto default;
00f872d949ea Added method scanCommentText() to DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 744
diff changeset
360 default:
00f872d949ea Added method scanCommentText() to DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 744
diff changeset
361 result ~= *p;
00f872d949ea Added method scanCommentText() to DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 744
diff changeset
362 }
00f872d949ea Added method scanCommentText() to DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 744
diff changeset
363 p++;
00f872d949ea Added method scanCommentText() to DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 744
diff changeset
364 }
00f872d949ea Added method scanCommentText() to DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 744
diff changeset
365 return result;
00f872d949ea Added method scanCommentText() to DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 744
diff changeset
366 }
00f872d949ea Added method scanCommentText() to DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 744
diff changeset
367
751
8caf18892c1b Improved DDocEmitter and fixed bugs.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 747
diff changeset
368 /// Escapes '<', '>' and '&' with named HTML entities.
8caf18892c1b Improved DDocEmitter and fixed bugs.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 747
diff changeset
369 char[] escape(char[] text)
8caf18892c1b Improved DDocEmitter and fixed bugs.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 747
diff changeset
370 {
8caf18892c1b Improved DDocEmitter and fixed bugs.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 747
diff changeset
371 char[] result = new char[text.length]; // Reserve space.
8caf18892c1b Improved DDocEmitter and fixed bugs.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 747
diff changeset
372 result.length = 0;
8caf18892c1b Improved DDocEmitter and fixed bugs.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 747
diff changeset
373 foreach(c; text)
8caf18892c1b Improved DDocEmitter and fixed bugs.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 747
diff changeset
374 switch(c)
8caf18892c1b Improved DDocEmitter and fixed bugs.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 747
diff changeset
375 {
8caf18892c1b Improved DDocEmitter and fixed bugs.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 747
diff changeset
376 case '<': result ~= "&lt;"; break;
8caf18892c1b Improved DDocEmitter and fixed bugs.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 747
diff changeset
377 case '>': result ~= "&gt;"; break;
8caf18892c1b Improved DDocEmitter and fixed bugs.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 747
diff changeset
378 case '&': result ~= "&amp;"; break;
8caf18892c1b Improved DDocEmitter and fixed bugs.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 747
diff changeset
379 default: result ~= c;
8caf18892c1b Improved DDocEmitter and fixed bugs.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 747
diff changeset
380 }
8caf18892c1b Improved DDocEmitter and fixed bugs.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 747
diff changeset
381 if (result.length != text.length)
8caf18892c1b Improved DDocEmitter and fixed bugs.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 747
diff changeset
382 return result;
8caf18892c1b Improved DDocEmitter and fixed bugs.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 747
diff changeset
383 // Nothing escaped. Return original text.
8caf18892c1b Improved DDocEmitter and fixed bugs.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 747
diff changeset
384 delete result;
8caf18892c1b Improved DDocEmitter and fixed bugs.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 747
diff changeset
385 return text;
8caf18892c1b Improved DDocEmitter and fixed bugs.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 747
diff changeset
386 }
8caf18892c1b Improved DDocEmitter and fixed bugs.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 747
diff changeset
387
747
00f872d949ea Added method scanCommentText() to DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 744
diff changeset
388 void writeParams(Parameters params)
00f872d949ea Added method scanCommentText() to DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 744
diff changeset
389 {
00f872d949ea Added method scanCommentText() to DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 744
diff changeset
390 if (!params.items.length)
00f872d949ea Added method scanCommentText() to DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 744
diff changeset
391 return write("()");
00f872d949ea Added method scanCommentText() to DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 744
diff changeset
392 write("(");
00f872d949ea Added method scanCommentText() to DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 744
diff changeset
393 auto lastParam = params.items[$-1];
00f872d949ea Added method scanCommentText() to DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 744
diff changeset
394 foreach (param; params.items)
00f872d949ea Added method scanCommentText() to DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 744
diff changeset
395 {
00f872d949ea Added method scanCommentText() to DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 744
diff changeset
396 if (param.isCVariadic)
00f872d949ea Added method scanCommentText() to DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 744
diff changeset
397 write("...");
00f872d949ea Added method scanCommentText() to DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 744
diff changeset
398 else
00f872d949ea Added method scanCommentText() to DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 744
diff changeset
399 {
00f872d949ea Added method scanCommentText() to DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 744
diff changeset
400 assert(param.type);
00f872d949ea Added method scanCommentText() to DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 744
diff changeset
401 // Write storage classes.
00f872d949ea Added method scanCommentText() to DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 744
diff changeset
402 auto typeBegin = param.type.baseType.begin;
751
8caf18892c1b Improved DDocEmitter and fixed bugs.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 747
diff changeset
403 if (typeBegin !is param.begin) // Write storage classes.
747
00f872d949ea Added method scanCommentText() to DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 744
diff changeset
404 write(textSpan(param.begin, typeBegin.prevNWS), " ");
751
8caf18892c1b Improved DDocEmitter and fixed bugs.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 747
diff changeset
405 write(escape(textSpan(typeBegin, param.type.end))); // Write type.
8caf18892c1b Improved DDocEmitter and fixed bugs.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 747
diff changeset
406 if (param.name)
8caf18892c1b Improved DDocEmitter and fixed bugs.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 747
diff changeset
407 write(" $(DDOC_PARAM ", param.name.str, ")");
747
00f872d949ea Added method scanCommentText() to DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 744
diff changeset
408 if (param.isDVariadic)
00f872d949ea Added method scanCommentText() to DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 744
diff changeset
409 write("...");
751
8caf18892c1b Improved DDocEmitter and fixed bugs.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 747
diff changeset
410 if (param.defValue)
8caf18892c1b Improved DDocEmitter and fixed bugs.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 747
diff changeset
411 write(" = ", escape(textSpan(param.defValue.begin, param.defValue.end)));
747
00f872d949ea Added method scanCommentText() to DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 744
diff changeset
412 }
00f872d949ea Added method scanCommentText() to DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 744
diff changeset
413 if (param !is lastParam)
00f872d949ea Added method scanCommentText() to DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 744
diff changeset
414 write(", ");
00f872d949ea Added method scanCommentText() to DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 744
diff changeset
415 }
00f872d949ea Added method scanCommentText() to DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 744
diff changeset
416 write(")");
00f872d949ea Added method scanCommentText() to DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 744
diff changeset
417 }
00f872d949ea Added method scanCommentText() to DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 744
diff changeset
418
737
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
419 void writeTemplateParams()
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
420 {
766
0af3b145a405 Revised TemplateParameterList parsing functions.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 765
diff changeset
421 if (!tparams)
737
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
422 return;
766
0af3b145a405 Revised TemplateParameterList parsing functions.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 765
diff changeset
423 write(escape(textSpan(tparams.begin, tparams.end)));
737
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
424 tparams = null;
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
425 }
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
426
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
427 void writeInheritanceList(BaseClassType[] bases)
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
428 {
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
429 if (bases.length == 0)
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
430 return;
751
8caf18892c1b Improved DDocEmitter and fixed bugs.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 747
diff changeset
431 auto basesBegin = bases[0].begin.prevNWS;
8caf18892c1b Improved DDocEmitter and fixed bugs.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 747
diff changeset
432 if (basesBegin.kind == TOK.Colon)
8caf18892c1b Improved DDocEmitter and fixed bugs.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 747
diff changeset
433 basesBegin = bases[0].begin;
777
9f61e8af55d5 Added module dil.Compilation.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 776
diff changeset
434 write(" : ", escape(textSpan(basesBegin, bases[$-1].end)));
737
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
435 }
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
436
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
437 void write(char[][] strings...)
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
438 {
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
439 foreach (s; strings)
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
440 text ~= s;
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
441 }
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
442
770
26d8ed59806d Emitting SYMBOL macro with interesting parameters.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 766
diff changeset
443 void SYMBOL(char[] name, Declaration d)
737
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
444 {
770
26d8ed59806d Emitting SYMBOL macro with interesting parameters.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 766
diff changeset
445 auto loc = d.begin.getRealLocation();
777
9f61e8af55d5 Added module dil.Compilation.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 776
diff changeset
446 auto str = Format("$(SYMBOL {}, {})", name, loc.lineNum);
770
26d8ed59806d Emitting SYMBOL macro with interesting parameters.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 766
diff changeset
447 write(str);
26d8ed59806d Emitting SYMBOL macro with interesting parameters.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 766
diff changeset
448 // write("$(DDOC_PSYMBOL ", name, ")");
737
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
449 }
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
450
751
8caf18892c1b Improved DDocEmitter and fixed bugs.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 747
diff changeset
451 uint prevDeclOffset;
8caf18892c1b Improved DDocEmitter and fixed bugs.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 747
diff changeset
452
775
e76c9fdb83a3 DDocEmitter emits declaration attributes now.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 773
diff changeset
453 void DECL(void delegate() dg, Declaration d, bool writeSemicolon = true)
737
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
454 {
751
8caf18892c1b Improved DDocEmitter and fixed bugs.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 747
diff changeset
455 if (cmntIsDitto)
8caf18892c1b Improved DDocEmitter and fixed bugs.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 747
diff changeset
456 { alias prevDeclOffset offs;
8caf18892c1b Improved DDocEmitter and fixed bugs.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 747
diff changeset
457 assert(offs != 0);
8caf18892c1b Improved DDocEmitter and fixed bugs.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 747
diff changeset
458 auto savedText = text;
8caf18892c1b Improved DDocEmitter and fixed bugs.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 747
diff changeset
459 text = "";
8caf18892c1b Improved DDocEmitter and fixed bugs.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 747
diff changeset
460 write("\n$(DDOC_DECL ");
8caf18892c1b Improved DDocEmitter and fixed bugs.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 747
diff changeset
461 dg();
775
e76c9fdb83a3 DDocEmitter emits declaration attributes now.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 773
diff changeset
462 writeSemicolon && write(";");
e76c9fdb83a3 DDocEmitter emits declaration attributes now.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 773
diff changeset
463 writeAttributes(d);
e76c9fdb83a3 DDocEmitter emits declaration attributes now.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 773
diff changeset
464 write(")");
751
8caf18892c1b Improved DDocEmitter and fixed bugs.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 747
diff changeset
465 // Insert text at offset.
8caf18892c1b Improved DDocEmitter and fixed bugs.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 747
diff changeset
466 auto len = text.length;
8caf18892c1b Improved DDocEmitter and fixed bugs.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 747
diff changeset
467 text = savedText[0..offs] ~ text ~ savedText[offs..$];
8caf18892c1b Improved DDocEmitter and fixed bugs.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 747
diff changeset
468 offs += len; // Add length of the inserted text to the offset.
8caf18892c1b Improved DDocEmitter and fixed bugs.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 747
diff changeset
469 return;
8caf18892c1b Improved DDocEmitter and fixed bugs.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 747
diff changeset
470 }
737
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
471 write("\n$(DDOC_DECL ");
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
472 dg();
775
e76c9fdb83a3 DDocEmitter emits declaration attributes now.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 773
diff changeset
473 writeSemicolon && write(";");
e76c9fdb83a3 DDocEmitter emits declaration attributes now.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 773
diff changeset
474 writeAttributes(d);
e76c9fdb83a3 DDocEmitter emits declaration attributes now.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 773
diff changeset
475 write(")");
751
8caf18892c1b Improved DDocEmitter and fixed bugs.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 747
diff changeset
476 prevDeclOffset = text.length;
737
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
477 }
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
478
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
479 void DESC(void delegate() dg)
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
480 {
751
8caf18892c1b Improved DDocEmitter and fixed bugs.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 747
diff changeset
481 if (cmntIsDitto)
8caf18892c1b Improved DDocEmitter and fixed bugs.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 747
diff changeset
482 return;
737
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
483 write("\n$(DDOC_DECL_DD ");
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
484 dg();
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
485 write(")");
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
486 }
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
487
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
488 void MEMBERS(char[] kind, void delegate() dg)
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
489 {
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
490 write("\n$(DDOC_"~kind~"_MEMBERS ");
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
491 dg();
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
492 write(")");
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
493 }
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
494
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
495 void writeClassOrInterface(T)(T d)
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
496 {
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
497 if (!ddoc(d))
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
498 return d;
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
499 DECL({
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
500 write(d.begin.srcText, " ");
770
26d8ed59806d Emitting SYMBOL macro with interesting parameters.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 766
diff changeset
501 SYMBOL(d.name.str, d);
737
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
502 writeTemplateParams();
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
503 writeInheritanceList(d.bases);
775
e76c9fdb83a3 DDocEmitter emits declaration attributes now.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 773
diff changeset
504 }, d);
737
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
505 DESC({
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
506 writeComment();
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
507 MEMBERS(is(T == ClassDeclaration) ? "CLASS" : "INTERFACE", {
751
8caf18892c1b Improved DDocEmitter and fixed bugs.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 747
diff changeset
508 scope s = new Scope();
737
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
509 d.decls && super.visit(d.decls);
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
510 });
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
511 });
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
512 }
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
513
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
514 void writeStructOrUnion(T)(T d)
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
515 {
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
516 if (!ddoc(d))
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
517 return d;
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
518 DECL({
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
519 write(d.begin.srcText, d.name ? " " : "");
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
520 if (d.name)
770
26d8ed59806d Emitting SYMBOL macro with interesting parameters.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 766
diff changeset
521 SYMBOL(d.name.str, d);
737
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
522 writeTemplateParams();
775
e76c9fdb83a3 DDocEmitter emits declaration attributes now.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 773
diff changeset
523 }, d);
737
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
524 DESC({
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
525 writeComment();
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
526 MEMBERS(is(T == StructDeclaration) ? "STRUCT" : "UNION", {
751
8caf18892c1b Improved DDocEmitter and fixed bugs.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 747
diff changeset
527 scope s = new Scope();
737
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
528 d.decls && super.visit(d.decls);
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
529 });
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
530 });
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
531 }
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
532
773
6dbbb403fc58 Improved the DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 772
diff changeset
533 void writeAliasOrTypedef(T)(T d)
6dbbb403fc58 Improved the DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 772
diff changeset
534 {
6dbbb403fc58 Improved the DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 772
diff changeset
535 auto prefix = is(T == AliasDeclaration) ? "alias " : "typedef ";
6dbbb403fc58 Improved the DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 772
diff changeset
536 if (auto vd = d.decl.Is!(VariablesDeclaration))
6dbbb403fc58 Improved the DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 772
diff changeset
537 {
6dbbb403fc58 Improved the DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 772
diff changeset
538 auto type = textSpan(vd.typeNode.baseType.begin, vd.typeNode.end);
6dbbb403fc58 Improved the DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 772
diff changeset
539 foreach (name; vd.names)
775
e76c9fdb83a3 DDocEmitter emits declaration attributes now.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 773
diff changeset
540 DECL({ write(prefix); write(escape(type), " "); SYMBOL(name.str, d); }, d);
773
6dbbb403fc58 Improved the DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 772
diff changeset
541 }
6dbbb403fc58 Improved the DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 772
diff changeset
542 else if (auto fd = d.decl.Is!(FunctionDeclaration))
6dbbb403fc58 Improved the DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 772
diff changeset
543 {}
6dbbb403fc58 Improved the DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 772
diff changeset
544 // DECL({ write(textSpan(d.begin, d.end)); }, false);
6dbbb403fc58 Improved the DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 772
diff changeset
545 DESC({ writeComment(); });
6dbbb403fc58 Improved the DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 772
diff changeset
546 }
6dbbb403fc58 Improved the DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 772
diff changeset
547
775
e76c9fdb83a3 DDocEmitter emits declaration attributes now.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 773
diff changeset
548 void writeAttributes(Declaration d)
e76c9fdb83a3 DDocEmitter emits declaration attributes now.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 773
diff changeset
549 {
e76c9fdb83a3 DDocEmitter emits declaration attributes now.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 773
diff changeset
550 char[][] attributes;
e76c9fdb83a3 DDocEmitter emits declaration attributes now.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 773
diff changeset
551
e76c9fdb83a3 DDocEmitter emits declaration attributes now.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 773
diff changeset
552 if (d.prot != Protection.None)
e76c9fdb83a3 DDocEmitter emits declaration attributes now.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 773
diff changeset
553 attributes ~= "$(PROT " ~ .toString(d.prot) ~ ")";
e76c9fdb83a3 DDocEmitter emits declaration attributes now.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 773
diff changeset
554
e76c9fdb83a3 DDocEmitter emits declaration attributes now.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 773
diff changeset
555 auto stc = d.stc;
e76c9fdb83a3 DDocEmitter emits declaration attributes now.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 773
diff changeset
556 stc &= ~StorageClass.Auto; // Ignore auto.
e76c9fdb83a3 DDocEmitter emits declaration attributes now.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 773
diff changeset
557 foreach (stcStr; .toStrings(stc))
e76c9fdb83a3 DDocEmitter emits declaration attributes now.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 773
diff changeset
558 attributes ~= "$(STC " ~ stcStr ~ ")";
e76c9fdb83a3 DDocEmitter emits declaration attributes now.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 773
diff changeset
559
e76c9fdb83a3 DDocEmitter emits declaration attributes now.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 773
diff changeset
560 LinkageType ltype;
e76c9fdb83a3 DDocEmitter emits declaration attributes now.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 773
diff changeset
561 if (auto vd = d.Is!(VariablesDeclaration))
e76c9fdb83a3 DDocEmitter emits declaration attributes now.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 773
diff changeset
562 ltype = vd.linkageType;
e76c9fdb83a3 DDocEmitter emits declaration attributes now.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 773
diff changeset
563 else if (auto fd = d.Is!(FunctionDeclaration))
e76c9fdb83a3 DDocEmitter emits declaration attributes now.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 773
diff changeset
564 ltype = fd.linkageType;
e76c9fdb83a3 DDocEmitter emits declaration attributes now.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 773
diff changeset
565
e76c9fdb83a3 DDocEmitter emits declaration attributes now.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 773
diff changeset
566 if (ltype != LinkageType.None)
e76c9fdb83a3 DDocEmitter emits declaration attributes now.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 773
diff changeset
567 attributes ~= "$(LINKAGE extern(" ~ .toString(ltype) ~ "))";
e76c9fdb83a3 DDocEmitter emits declaration attributes now.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 773
diff changeset
568
e76c9fdb83a3 DDocEmitter emits declaration attributes now.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 773
diff changeset
569 if (!attributes.length)
e76c9fdb83a3 DDocEmitter emits declaration attributes now.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 773
diff changeset
570 return;
e76c9fdb83a3 DDocEmitter emits declaration attributes now.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 773
diff changeset
571
e76c9fdb83a3 DDocEmitter emits declaration attributes now.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 773
diff changeset
572 write(" $(ATTRIBUTES ");
e76c9fdb83a3 DDocEmitter emits declaration attributes now.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 773
diff changeset
573 write(attributes[0]);
e76c9fdb83a3 DDocEmitter emits declaration attributes now.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 773
diff changeset
574 foreach (attribute; attributes[1..$])
e76c9fdb83a3 DDocEmitter emits declaration attributes now.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 773
diff changeset
575 write(", ", attribute);
e76c9fdb83a3 DDocEmitter emits declaration attributes now.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 773
diff changeset
576 write(")");
e76c9fdb83a3 DDocEmitter emits declaration attributes now.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 773
diff changeset
577 }
e76c9fdb83a3 DDocEmitter emits declaration attributes now.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 773
diff changeset
578
737
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
579 alias Declaration D;
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
580
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
581 override:
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
582 // D visit(ModuleDeclaration d)
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
583 // { return d; }
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
584
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
585 D visit(AliasDeclaration d)
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
586 {
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
587 if (!ddoc(d))
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
588 return d;
773
6dbbb403fc58 Improved the DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 772
diff changeset
589 writeAliasOrTypedef(d);
737
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
590 return d;
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
591 }
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
592
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
593 D visit(TypedefDeclaration d)
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
594 {
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
595 if (!ddoc(d))
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
596 return d;
773
6dbbb403fc58 Improved the DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 772
diff changeset
597 writeAliasOrTypedef(d);
737
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
598 return d;
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
599 }
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
600
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
601 D visit(EnumDeclaration d)
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
602 {
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
603 if (!ddoc(d))
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
604 return d;
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
605 DECL({
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
606 write("enum", d.name ? " " : "");
770
26d8ed59806d Emitting SYMBOL macro with interesting parameters.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 766
diff changeset
607 d.name && SYMBOL(d.name.str, d);
775
e76c9fdb83a3 DDocEmitter emits declaration attributes now.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 773
diff changeset
608 }, d);
737
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
609 DESC({
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
610 writeComment();
751
8caf18892c1b Improved DDocEmitter and fixed bugs.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 747
diff changeset
611 MEMBERS("ENUM", { scope s = new Scope(); super.visit(d); });
737
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
612 });
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
613 return d;
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
614 }
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
615
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
616 D visit(EnumMemberDeclaration d)
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
617 {
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
618 if (!ddoc(d))
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
619 return d;
775
e76c9fdb83a3 DDocEmitter emits declaration attributes now.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 773
diff changeset
620 DECL({ SYMBOL(d.name.str, d); }, d, false);
737
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
621 DESC({ writeComment(); });
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
622 return d;
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
623 }
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
624
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
625 D visit(TemplateDeclaration d)
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
626 {
751
8caf18892c1b Improved DDocEmitter and fixed bugs.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 747
diff changeset
627 this.tparams = d.tparams;
737
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
628 if (d.begin.kind != TOK.Template)
765
bc812843603c Template functions are wrapped inside TemplateDeclarations now.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 764
diff changeset
629 { // This is a templatized class/interface/struct/union/function.
bc812843603c Template functions are wrapped inside TemplateDeclarations now.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 764
diff changeset
630 super.visit(d.decls);
bc812843603c Template functions are wrapped inside TemplateDeclarations now.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 764
diff changeset
631 this.tparams = null;
bc812843603c Template functions are wrapped inside TemplateDeclarations now.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 764
diff changeset
632 return d;
bc812843603c Template functions are wrapped inside TemplateDeclarations now.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 764
diff changeset
633 }
737
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
634 if (!ddoc(d))
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
635 return d;
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
636 DECL({
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
637 write("template ");
770
26d8ed59806d Emitting SYMBOL macro with interesting parameters.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 766
diff changeset
638 SYMBOL(d.name.str, d);
751
8caf18892c1b Improved DDocEmitter and fixed bugs.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 747
diff changeset
639 writeTemplateParams();
775
e76c9fdb83a3 DDocEmitter emits declaration attributes now.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 773
diff changeset
640 }, d);
737
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
641 DESC({
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
642 writeComment();
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
643 MEMBERS("TEMPLATE", {
751
8caf18892c1b Improved DDocEmitter and fixed bugs.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 747
diff changeset
644 scope s = new Scope();
737
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
645 super.visit(d.decls);
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
646 });
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
647 });
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
648 return d;
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
649 }
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
650
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
651 D visit(ClassDeclaration d)
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
652 {
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
653 writeClassOrInterface(d);
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
654 return d;
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
655 }
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
656
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
657 D visit(InterfaceDeclaration d)
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
658 {
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
659 writeClassOrInterface(d);
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
660 return d;
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
661 }
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
662
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
663 D visit(StructDeclaration d)
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
664 {
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
665 writeStructOrUnion(d);
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
666 return d;
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
667 }
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
668
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
669 D visit(UnionDeclaration d)
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
670 {
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
671 writeStructOrUnion(d);
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
672 return d;
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
673 }
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
674
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
675 D visit(ConstructorDeclaration d)
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
676 {
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
677 if (!ddoc(d))
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
678 return d;
775
e76c9fdb83a3 DDocEmitter emits declaration attributes now.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 773
diff changeset
679 DECL({ SYMBOL("this", d); writeParams(d.params); }, d);
737
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
680 DESC({ writeComment(); });
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
681 return d;
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
682 }
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
683
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
684 D visit(StaticConstructorDeclaration d)
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
685 {
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
686 if (!ddoc(d))
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
687 return d;
775
e76c9fdb83a3 DDocEmitter emits declaration attributes now.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 773
diff changeset
688 DECL({ write("static "); SYMBOL("this", d); write("()"); }, d);
737
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
689 DESC({ writeComment(); });
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
690 return d;
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
691 }
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
692
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
693 D visit(DestructorDeclaration d)
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
694 {
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
695 if (!ddoc(d))
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
696 return d;
775
e76c9fdb83a3 DDocEmitter emits declaration attributes now.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 773
diff changeset
697 DECL({ write("~"); SYMBOL("this", d); write("()"); }, d);
737
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
698 DESC({ writeComment(); });
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
699 return d;
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
700 }
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
701
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
702 D visit(StaticDestructorDeclaration d)
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
703 {
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
704 if (!ddoc(d))
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
705 return d;
775
e76c9fdb83a3 DDocEmitter emits declaration attributes now.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 773
diff changeset
706 DECL({ write("static ~"); SYMBOL("this", d); write("()"); }, d);
737
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
707 DESC({ writeComment(); });
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
708 return d;
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
709 }
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
710
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
711 D visit(FunctionDeclaration d)
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
712 {
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
713 if (!ddoc(d))
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
714 return d;
747
00f872d949ea Added method scanCommentText() to DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 744
diff changeset
715 auto type = textSpan(d.returnType.baseType.begin, d.returnType.end);
751
8caf18892c1b Improved DDocEmitter and fixed bugs.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 747
diff changeset
716 DECL({
8caf18892c1b Improved DDocEmitter and fixed bugs.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 747
diff changeset
717 write(escape(type), " ");
770
26d8ed59806d Emitting SYMBOL macro with interesting parameters.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 766
diff changeset
718 SYMBOL(d.name.str, d);
751
8caf18892c1b Improved DDocEmitter and fixed bugs.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 747
diff changeset
719 writeTemplateParams();
8caf18892c1b Improved DDocEmitter and fixed bugs.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 747
diff changeset
720 writeParams(d.params);
775
e76c9fdb83a3 DDocEmitter emits declaration attributes now.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 773
diff changeset
721 }, d);
737
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
722 DESC({ writeComment(); });
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
723 return d;
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
724 }
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
725
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
726 D visit(NewDeclaration d)
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
727 {
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
728 if (!ddoc(d))
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
729 return d;
775
e76c9fdb83a3 DDocEmitter emits declaration attributes now.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 773
diff changeset
730 DECL({ SYMBOL("new", d); writeParams(d.params); }, d);
737
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
731 DESC({ writeComment(); });
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
732 return d;
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
733 }
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
734
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
735 D visit(DeleteDeclaration d)
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
736 {
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
737 if (!ddoc(d))
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
738 return d;
775
e76c9fdb83a3 DDocEmitter emits declaration attributes now.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 773
diff changeset
739 DECL({ SYMBOL("delete", d); writeParams(d.params); }, d);
737
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
740 DESC({ writeComment(); });
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
741 return d;
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
742 }
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
743
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
744 D visit(VariablesDeclaration d)
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
745 {
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
746 if (!ddoc(d))
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
747 return d;
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
748 char[] type = "auto";
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
749 if (d.typeNode)
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
750 type = textSpan(d.typeNode.baseType.begin, d.typeNode.end);
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
751 foreach (name; d.names)
775
e76c9fdb83a3 DDocEmitter emits declaration attributes now.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 773
diff changeset
752 DECL({ write(escape(type), " "); SYMBOL(name.str, d); }, d);
761
307905dadf5d DDoc code sections are highlighted now.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 754
diff changeset
753 DESC({ writeComment(); });
737
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
754 return d;
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
755 }
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
756
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
757 D visit(InvariantDeclaration d)
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
758 {
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
759 if (!ddoc(d))
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
760 return d;
775
e76c9fdb83a3 DDocEmitter emits declaration attributes now.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 773
diff changeset
761 DECL({ SYMBOL("invariant", d); }, d);
737
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
762 DESC({ writeComment(); });
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
763 return d;
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
764 }
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
765
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
766 D visit(UnittestDeclaration d)
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
767 {
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
768 if (!ddoc(d))
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
769 return d;
775
e76c9fdb83a3 DDocEmitter emits declaration attributes now.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 773
diff changeset
770 DECL({ SYMBOL("unittest", d); }, d);
737
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
771 DESC({ writeComment(); });
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
772 return d;
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
773 }
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
774
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
775 D visit(DebugDeclaration d)
778
78be32e3e157 Implemented conditional compilation.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 777
diff changeset
776 {
78be32e3e157 Implemented conditional compilation.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 777
diff changeset
777 d.compiledDecls && visitD(d.compiledDecls);
78be32e3e157 Implemented conditional compilation.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 777
diff changeset
778 return d;
78be32e3e157 Implemented conditional compilation.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 777
diff changeset
779 }
737
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
780
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
781 D visit(VersionDeclaration d)
778
78be32e3e157 Implemented conditional compilation.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 777
diff changeset
782 {
78be32e3e157 Implemented conditional compilation.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 777
diff changeset
783 d.compiledDecls && visitD(d.compiledDecls);
78be32e3e157 Implemented conditional compilation.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 777
diff changeset
784 return d;
78be32e3e157 Implemented conditional compilation.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 777
diff changeset
785 }
78be32e3e157 Implemented conditional compilation.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 777
diff changeset
786
78be32e3e157 Implemented conditional compilation.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 777
diff changeset
787 D visit(StaticIfDeclaration d)
78be32e3e157 Implemented conditional compilation.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 777
diff changeset
788 {
78be32e3e157 Implemented conditional compilation.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 777
diff changeset
789 d.ifDecls && visitD(d.ifDecls);
78be32e3e157 Implemented conditional compilation.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 777
diff changeset
790 return d;
78be32e3e157 Implemented conditional compilation.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 777
diff changeset
791 }
731
ca7607226caa Added new module cmd.DDoc.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents:
diff changeset
792 }