Mercurial > projects > dil

annotate trunk/src/dil/doc/Doc.d @ 737:f88b5285b86b

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Implemented DDocEmitter. Fixed quite a few bugs.
author Aziz K?ksal <aziz.koeksal@gmail.com>
date Sat, 09 Feb 2008 02:00:20 +0100
parents ca7607226caa
children 49fe21aa387c
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
676
c4e3a34e40f1 Added new module dil.doc.Doc.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents:
diff changeset
1 /++
c4e3a34e40f1 Added new module dil.doc.Doc.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents:
diff changeset
2 Author: Aziz Köksal
c4e3a34e40f1 Added new module dil.doc.Doc.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents:
diff changeset
3 License: GPL3
c4e3a34e40f1 Added new module dil.doc.Doc.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents:
diff changeset
4 +/
c4e3a34e40f1 Added new module dil.doc.Doc.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents:
diff changeset
5 module dil.doc.Doc;
c4e3a34e40f1 Added new module dil.doc.Doc.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents:
diff changeset
6
728
41cad5ca4863 Added ParamsSection and MacrosSection.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 722
diff changeset
7 import dil.doc.Parser;
676
c4e3a34e40f1 Added new module dil.doc.Doc.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents:
diff changeset
8 import dil.ast.Node;
712
f8875ef9a66d Added function sanitize() to dil.doc.Doc.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 680
diff changeset
9 import dil.lexer.Funcs;
716
08e6174a2e1c Added class DDocComment.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 714
diff changeset
10 import dil.Unicode;
712
f8875ef9a66d Added function sanitize() to dil.doc.Doc.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 680
diff changeset
11 import common;
676
c4e3a34e40f1 Added new module dil.doc.Doc.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents:
diff changeset
12
731
ca7607226caa Added new module cmd.DDoc.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 728
diff changeset
13 import tango.text.Ascii : toLower;
ca7607226caa Added new module cmd.DDoc.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 728
diff changeset
14
716
08e6174a2e1c Added class DDocComment.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 714
diff changeset
15 class DDocComment
08e6174a2e1c Added class DDocComment.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 714
diff changeset
16 {
737
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
17 Section[] sections; /// The sections of this comment.
716
08e6174a2e1c Added class DDocComment.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 714
diff changeset
18 Section summary; /// Optional summary section.
08e6174a2e1c Added class DDocComment.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 714
diff changeset
19 Section description; /// Optional description section.
08e6174a2e1c Added class DDocComment.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 714
diff changeset
20
722
ceaac6a24258 Added isUnicodeAlpha() for DDocParser and MacroParser.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 718
diff changeset
21 this(Section[] sections, Section summary, Section description)
716
08e6174a2e1c Added class DDocComment.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 714
diff changeset
22 {
722
ceaac6a24258 Added isUnicodeAlpha() for DDocParser and MacroParser.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 718
diff changeset
23 this.sections = sections;
ceaac6a24258 Added isUnicodeAlpha() for DDocParser and MacroParser.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 718
diff changeset
24 this.summary = summary;
ceaac6a24258 Added isUnicodeAlpha() for DDocParser and MacroParser.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 718
diff changeset
25 this.description = description;
716
08e6174a2e1c Added class DDocComment.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 714
diff changeset
26 }
731
ca7607226caa Added new module cmd.DDoc.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 728
diff changeset
27
737
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
28 /// Removes the first copyright section and returns it.
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
29 Section takeCopyright()
731
ca7607226caa Added new module cmd.DDoc.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 728
diff changeset
30 {
737
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
31 foreach (i, section; sections)
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
32 if (section.Is("copyright"))
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
33 {
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
34 sections = sections[0..i] ~ sections[i+1..$];
731
ca7607226caa Added new module cmd.DDoc.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 728
diff changeset
35 return section;
737
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
36 }
731
ca7607226caa Added new module cmd.DDoc.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 728
diff changeset
37 return null;
ca7607226caa Added new module cmd.DDoc.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 728
diff changeset
38 }
737
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
39
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
40 /// Returns: true if "ditto" is the only text in this comment.
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
41 bool isDitto()
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
42 {
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
43 if (summary && sections.length == 1 &&
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
44 toLower(strip(summary.text.dup)) == "ditto")
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
45 return true;
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
46 return false;
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
47 }
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
48
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
49 // MacrosSection[] getMacros()
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
50 // {
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
51 // MacrosSection[] macros;
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
52 // foreach (section; sections)
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
53 // if (section.Is("macros"))
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
54 // macros ~= new MacrosSection(section.name, section.text);
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
55 // return macros;
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
56 // }
731
ca7607226caa Added new module cmd.DDoc.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 728
diff changeset
57 }
ca7607226caa Added new module cmd.DDoc.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 728
diff changeset
58
ca7607226caa Added new module cmd.DDoc.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 728
diff changeset
59 /// Returns a node's DDocComment.
ca7607226caa Added new module cmd.DDoc.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 728
diff changeset
60 DDocComment getDDocComment(Node node)
ca7607226caa Added new module cmd.DDoc.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 728
diff changeset
61 {
ca7607226caa Added new module cmd.DDoc.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 728
diff changeset
62 DDocParser p;
ca7607226caa Added new module cmd.DDoc.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 728
diff changeset
63 p.parse(getDDocText(getDocTokens(node)));
737
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
64 if (p.sections.length)
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
65 return new DDocComment(p.sections, p.summary, p.description);
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
66 return null;
722
ceaac6a24258 Added isUnicodeAlpha() for DDocParser and MacroParser.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 718
diff changeset
67 }
ceaac6a24258 Added isUnicodeAlpha() for DDocParser and MacroParser.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 718
diff changeset
68
737
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
69 /// Strips leading and trailing whitespace characters.
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
70 /// Whitespace: ' ', '\t', '\v', '\f' and '\n'
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
71 char[] strip(char[] str)
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
72 {
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
73 if (str.length == 0)
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
74 return null;
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
75 uint i;
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
76 for (; i < str.length; i++)
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
77 if (!isspace(str[i]) && str[i] != '\n')
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
78 break;
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
79 if (str.length == i)
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
80 return null;
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
81 str = str[i..$];
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
82 assert(str.length);
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
83 for (i = str.length; i; i--)
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
84 if (!isspace(str[i-1]) && str[i-1] != '\n')
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
85 break;
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
86 return str[0..i];
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
87 }
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
88
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
89 /// Parses a DDoc comment string.
722
ceaac6a24258 Added isUnicodeAlpha() for DDocParser and MacroParser.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 718
diff changeset
90 struct DDocParser
ceaac6a24258 Added isUnicodeAlpha() for DDocParser and MacroParser.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 718
diff changeset
91 {
ceaac6a24258 Added isUnicodeAlpha() for DDocParser and MacroParser.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 718
diff changeset
92 char* p;
ceaac6a24258 Added isUnicodeAlpha() for DDocParser and MacroParser.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 718
diff changeset
93 char* textEnd;
737
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
94 Section[] sections; /// Parsed sections.
722
ceaac6a24258 Added isUnicodeAlpha() for DDocParser and MacroParser.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 718
diff changeset
95 Section summary; /// Optional summary section.
ceaac6a24258 Added isUnicodeAlpha() for DDocParser and MacroParser.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 718
diff changeset
96 Section description; /// Optional description section.
716
08e6174a2e1c Added class DDocComment.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 714
diff changeset
97
08e6174a2e1c Added class DDocComment.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 714
diff changeset
98 /// Parses the DDoc text into sections.
722
ceaac6a24258 Added isUnicodeAlpha() for DDocParser and MacroParser.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 718
diff changeset
99 Section[] parse(string text)
716
08e6174a2e1c Added class DDocComment.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 714
diff changeset
100 {
722
ceaac6a24258 Added isUnicodeAlpha() for DDocParser and MacroParser.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 718
diff changeset
101 if (!text.length)
ceaac6a24258 Added isUnicodeAlpha() for DDocParser and MacroParser.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 718
diff changeset
102 return null;
ceaac6a24258 Added isUnicodeAlpha() for DDocParser and MacroParser.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 718
diff changeset
103 p = text.ptr;
ceaac6a24258 Added isUnicodeAlpha() for DDocParser and MacroParser.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 718
diff changeset
104 textEnd = p + text.length;
ceaac6a24258 Added isUnicodeAlpha() for DDocParser and MacroParser.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 718
diff changeset
105
716
08e6174a2e1c Added class DDocComment.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 714
diff changeset
106 char* summaryBegin;
08e6174a2e1c Added class DDocComment.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 714
diff changeset
107 char* idBegin, idEnd;
08e6174a2e1c Added class DDocComment.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 714
diff changeset
108 char* nextIdBegin, nextIdEnd;
08e6174a2e1c Added class DDocComment.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 714
diff changeset
109
08e6174a2e1c Added class DDocComment.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 714
diff changeset
110 skipWhitespace(p);
08e6174a2e1c Added class DDocComment.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 714
diff changeset
111 summaryBegin = p;
08e6174a2e1c Added class DDocComment.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 714
diff changeset
112
722
ceaac6a24258 Added isUnicodeAlpha() for DDocParser and MacroParser.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 718
diff changeset
113 if (findNextIdColon(idBegin, idEnd))
716
08e6174a2e1c Added class DDocComment.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 714
diff changeset
114 { // Check that this is not an explicit section.
08e6174a2e1c Added class DDocComment.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 714
diff changeset
115 if (summaryBegin != idBegin)
08e6174a2e1c Added class DDocComment.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 714
diff changeset
116 scanSummaryAndDescription(summaryBegin, idBegin);
08e6174a2e1c Added class DDocComment.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 714
diff changeset
117 }
08e6174a2e1c Added class DDocComment.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 714
diff changeset
118 else // There are no explicit sections.
722
ceaac6a24258 Added isUnicodeAlpha() for DDocParser and MacroParser.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 718
diff changeset
119 {
ceaac6a24258 Added isUnicodeAlpha() for DDocParser and MacroParser.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 718
diff changeset
120 scanSummaryAndDescription(summaryBegin, textEnd);
737
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
121 return sections;
722
ceaac6a24258 Added isUnicodeAlpha() for DDocParser and MacroParser.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 718
diff changeset
122 }
716
08e6174a2e1c Added class DDocComment.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 714
diff changeset
123
08e6174a2e1c Added class DDocComment.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 714
diff changeset
124 assert(idBegin && idEnd);
737
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
125 // Continue parsing.
722
ceaac6a24258 Added isUnicodeAlpha() for DDocParser and MacroParser.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 718
diff changeset
126 while (findNextIdColon(nextIdBegin, nextIdEnd))
716
08e6174a2e1c Added class DDocComment.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 714
diff changeset
127 {
08e6174a2e1c Added class DDocComment.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 714
diff changeset
128 sections ~= new Section(makeString(idBegin, idEnd), makeString(idEnd+1, nextIdBegin));
08e6174a2e1c Added class DDocComment.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 714
diff changeset
129 idBegin = nextIdBegin;
08e6174a2e1c Added class DDocComment.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 714
diff changeset
130 idEnd = nextIdEnd;
08e6174a2e1c Added class DDocComment.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 714
diff changeset
131 }
08e6174a2e1c Added class DDocComment.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 714
diff changeset
132 // Add last section.
08e6174a2e1c Added class DDocComment.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 714
diff changeset
133 sections ~= new Section(makeString(idBegin, idEnd), makeString(idEnd+1, textEnd));
722
ceaac6a24258 Added isUnicodeAlpha() for DDocParser and MacroParser.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 718
diff changeset
134 return sections;
716
08e6174a2e1c Added class DDocComment.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 714
diff changeset
135 }
08e6174a2e1c Added class DDocComment.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 714
diff changeset
136
08e6174a2e1c Added class DDocComment.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 714
diff changeset
137 void scanSummaryAndDescription(char* p, char* end)
08e6174a2e1c Added class DDocComment.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 714
diff changeset
138 {
722
ceaac6a24258 Added isUnicodeAlpha() for DDocParser and MacroParser.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 718
diff changeset
139 assert(p < end);
716
08e6174a2e1c Added class DDocComment.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 714
diff changeset
140 char* sectionBegin = p;
08e6174a2e1c Added class DDocComment.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 714
diff changeset
141 // Search for the end of the first paragraph.
737
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
142 end--; // Decrement end, so we can look ahead one character.
722
ceaac6a24258 Added isUnicodeAlpha() for DDocParser and MacroParser.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 718
diff changeset
143 while (p < end && !(*p == '\n' && p[1] == '\n'))
716
08e6174a2e1c Added class DDocComment.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 714
diff changeset
144 p++;
737
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
145 end++;
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
146 if (p+1 >= end)
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
147 p = end;
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
148 assert(p == end || (*p == '\n' && p[1] == '\n'));
716
08e6174a2e1c Added class DDocComment.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 714
diff changeset
149 // The first paragraph is the summary.
08e6174a2e1c Added class DDocComment.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 714
diff changeset
150 summary = new Section("", makeString(sectionBegin, p));
08e6174a2e1c Added class DDocComment.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 714
diff changeset
151 sections ~= summary;
08e6174a2e1c Added class DDocComment.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 714
diff changeset
152 // The rest is the description section.
737
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
153 if (p < end)
716
08e6174a2e1c Added class DDocComment.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 714
diff changeset
154 {
737
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
155 skipWhitespace(p);
716
08e6174a2e1c Added class DDocComment.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 714
diff changeset
156 sectionBegin = p;
08e6174a2e1c Added class DDocComment.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 714
diff changeset
157 if (p < end)
08e6174a2e1c Added class DDocComment.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 714
diff changeset
158 {
08e6174a2e1c Added class DDocComment.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 714
diff changeset
159 description = new Section("", makeString(sectionBegin, end));
08e6174a2e1c Added class DDocComment.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 714
diff changeset
160 sections ~= description;
08e6174a2e1c Added class DDocComment.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 714
diff changeset
161 }
08e6174a2e1c Added class DDocComment.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 714
diff changeset
162 }
08e6174a2e1c Added class DDocComment.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 714
diff changeset
163 }
08e6174a2e1c Added class DDocComment.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 714
diff changeset
164
08e6174a2e1c Added class DDocComment.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 714
diff changeset
165 void skipWhitespace(ref char* p)
08e6174a2e1c Added class DDocComment.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 714
diff changeset
166 {
737
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
167 while (p < textEnd && (isspace(*p) || *p == '\n'))
716
08e6174a2e1c Added class DDocComment.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 714
diff changeset
168 p++;
08e6174a2e1c Added class DDocComment.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 714
diff changeset
169 }
08e6174a2e1c Added class DDocComment.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 714
diff changeset
170
08e6174a2e1c Added class DDocComment.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 714
diff changeset
171 /// Find next "Identifier:".
08e6174a2e1c Added class DDocComment.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 714
diff changeset
172 /// Params:
08e6174a2e1c Added class DDocComment.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 714
diff changeset
173 /// idBegin = set to the first character of the Identifier
08e6174a2e1c Added class DDocComment.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 714
diff changeset
174 /// idEnd = set to the colon following the Identifier
08e6174a2e1c Added class DDocComment.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 714
diff changeset
175 /// Returns: true if found
722
ceaac6a24258 Added isUnicodeAlpha() for DDocParser and MacroParser.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 718
diff changeset
176 bool findNextIdColon(ref char* ref_idBegin, ref char* ref_idEnd)
716
08e6174a2e1c Added class DDocComment.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 714
diff changeset
177 {
737
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
178 while (p < textEnd)
716
08e6174a2e1c Added class DDocComment.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 714
diff changeset
179 {
737
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
180 skipWhitespace(p);
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
181 if (p >= textEnd)
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
182 break;
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
183 assert(isascii(*p) || isLeadByte(*p));
716
08e6174a2e1c Added class DDocComment.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 714
diff changeset
184 auto idBegin = p;
722
ceaac6a24258 Added isUnicodeAlpha() for DDocParser and MacroParser.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 718
diff changeset
185 if (isidbeg(*p) || isUnicodeAlpha(p, textEnd)) // IdStart
716
08e6174a2e1c Added class DDocComment.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 714
diff changeset
186 {
08e6174a2e1c Added class DDocComment.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 714
diff changeset
187 do // IdChar*
08e6174a2e1c Added class DDocComment.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 714
diff changeset
188 p++;
737
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
189 while (p < textEnd && (isident(*p) || isUnicodeAlpha(p, textEnd)))
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
190 if (p < textEnd && *p == ':') // :
716
08e6174a2e1c Added class DDocComment.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 714
diff changeset
191 {
08e6174a2e1c Added class DDocComment.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 714
diff changeset
192 ref_idBegin = idBegin;
08e6174a2e1c Added class DDocComment.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 714
diff changeset
193 ref_idEnd = p;
08e6174a2e1c Added class DDocComment.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 714
diff changeset
194 return true;
08e6174a2e1c Added class DDocComment.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 714
diff changeset
195 }
08e6174a2e1c Added class DDocComment.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 714
diff changeset
196 }
737
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
197 // Skip this line.
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
198 while (p < textEnd && *p != '\n')
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
199 p++;
716
08e6174a2e1c Added class DDocComment.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 714
diff changeset
200 }
08e6174a2e1c Added class DDocComment.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 714
diff changeset
201 return false;
08e6174a2e1c Added class DDocComment.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 714
diff changeset
202 }
08e6174a2e1c Added class DDocComment.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 714
diff changeset
203 }
08e6174a2e1c Added class DDocComment.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 714
diff changeset
204
08e6174a2e1c Added class DDocComment.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 714
diff changeset
205 class Section
08e6174a2e1c Added class DDocComment.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 714
diff changeset
206 {
08e6174a2e1c Added class DDocComment.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 714
diff changeset
207 string name;
08e6174a2e1c Added class DDocComment.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 714
diff changeset
208 string text;
08e6174a2e1c Added class DDocComment.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 714
diff changeset
209 this(string name, string text)
08e6174a2e1c Added class DDocComment.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 714
diff changeset
210 {
08e6174a2e1c Added class DDocComment.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 714
diff changeset
211 this.name = name;
08e6174a2e1c Added class DDocComment.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 714
diff changeset
212 this.text = text;
08e6174a2e1c Added class DDocComment.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 714
diff changeset
213 }
737
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
214
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
215 bool Is(char[] name2)
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
216 {
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
217 return toLower(name.dup) == name2;
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
218 }
716
08e6174a2e1c Added class DDocComment.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 714
diff changeset
219 }
08e6174a2e1c Added class DDocComment.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 714
diff changeset
220
728
41cad5ca4863 Added ParamsSection and MacrosSection.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 722
diff changeset
221 class ParamsSection : Section
716
08e6174a2e1c Added class DDocComment.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 714
diff changeset
222 {
728
41cad5ca4863 Added ParamsSection and MacrosSection.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 722
diff changeset
223 string[] paramNames; /// Parameter names.
41cad5ca4863 Added ParamsSection and MacrosSection.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 722
diff changeset
224 string[] paramDescs; /// Parameter descriptions.
41cad5ca4863 Added ParamsSection and MacrosSection.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 722
diff changeset
225 this(string name, string text)
41cad5ca4863 Added ParamsSection and MacrosSection.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 722
diff changeset
226 {
41cad5ca4863 Added ParamsSection and MacrosSection.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 722
diff changeset
227 super(name, text);
41cad5ca4863 Added ParamsSection and MacrosSection.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 722
diff changeset
228 IdentValueParser parser;
41cad5ca4863 Added ParamsSection and MacrosSection.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 722
diff changeset
229 auto idvalues = parser.parse(text);
41cad5ca4863 Added ParamsSection and MacrosSection.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 722
diff changeset
230 this.paramNames = new string[idvalues.length];
41cad5ca4863 Added ParamsSection and MacrosSection.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 722
diff changeset
231 this.paramDescs = new string[idvalues.length];
41cad5ca4863 Added ParamsSection and MacrosSection.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 722
diff changeset
232 foreach (i, idvalue; idvalues)
41cad5ca4863 Added ParamsSection and MacrosSection.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 722
diff changeset
233 {
41cad5ca4863 Added ParamsSection and MacrosSection.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 722
diff changeset
234 this.paramNames[i] = idvalue.ident;
41cad5ca4863 Added ParamsSection and MacrosSection.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 722
diff changeset
235 this.paramDescs[i] = idvalue.value;
41cad5ca4863 Added ParamsSection and MacrosSection.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 722
diff changeset
236 }
41cad5ca4863 Added ParamsSection and MacrosSection.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 722
diff changeset
237 }
41cad5ca4863 Added ParamsSection and MacrosSection.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 722
diff changeset
238 }
41cad5ca4863 Added ParamsSection and MacrosSection.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 722
diff changeset
239
41cad5ca4863 Added ParamsSection and MacrosSection.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 722
diff changeset
240 class MacrosSection : Section
41cad5ca4863 Added ParamsSection and MacrosSection.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 722
diff changeset
241 {
731
ca7607226caa Added new module cmd.DDoc.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 728
diff changeset
242 string[] macroNames; /// Macro names.
ca7607226caa Added new module cmd.DDoc.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 728
diff changeset
243 string[] macroTexts; /// Macro texts.
728
41cad5ca4863 Added ParamsSection and MacrosSection.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 722
diff changeset
244 this(string name, string text)
41cad5ca4863 Added ParamsSection and MacrosSection.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 722
diff changeset
245 {
41cad5ca4863 Added ParamsSection and MacrosSection.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 722
diff changeset
246 super(name, text);
41cad5ca4863 Added ParamsSection and MacrosSection.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 722
diff changeset
247 IdentValueParser parser;
41cad5ca4863 Added ParamsSection and MacrosSection.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 722
diff changeset
248 auto idvalues = parser.parse(text);
41cad5ca4863 Added ParamsSection and MacrosSection.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 722
diff changeset
249 this.macroNames = new string[idvalues.length];
41cad5ca4863 Added ParamsSection and MacrosSection.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 722
diff changeset
250 this.macroTexts = new string[idvalues.length];
41cad5ca4863 Added ParamsSection and MacrosSection.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 722
diff changeset
251 foreach (i, idvalue; idvalues)
41cad5ca4863 Added ParamsSection and MacrosSection.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 722
diff changeset
252 {
41cad5ca4863 Added ParamsSection and MacrosSection.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 722
diff changeset
253 this.macroNames[i] = idvalue.ident;
41cad5ca4863 Added ParamsSection and MacrosSection.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 722
diff changeset
254 this.macroTexts[i] = idvalue.value;
41cad5ca4863 Added ParamsSection and MacrosSection.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 722
diff changeset
255 }
41cad5ca4863 Added ParamsSection and MacrosSection.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 722
diff changeset
256 }
716
08e6174a2e1c Added class DDocComment.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 714
diff changeset
257 }
08e6174a2e1c Added class DDocComment.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 714
diff changeset
258
676
c4e3a34e40f1 Added new module dil.doc.Doc.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents:
diff changeset
259 bool isDoxygenComment(Token* token)
c4e3a34e40f1 Added new module dil.doc.Doc.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents:
diff changeset
260 { // Doxygen: '/+!' '/*!' '//!'
679
ff6971637f88 Renamed Token member type to kind.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 676
diff changeset
261 return token.kind == TOK.Comment && token.start[2] == '!';
676
c4e3a34e40f1 Added new module dil.doc.Doc.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents:
diff changeset
262 }
c4e3a34e40f1 Added new module dil.doc.Doc.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents:
diff changeset
263
c4e3a34e40f1 Added new module dil.doc.Doc.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents:
diff changeset
264 bool isDDocComment(Token* token)
c4e3a34e40f1 Added new module dil.doc.Doc.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents:
diff changeset
265 { // DDOC: '/++' '/**' '///'
679
ff6971637f88 Renamed Token member type to kind.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 676
diff changeset
266 return token.kind == TOK.Comment && token.start[1] == token.start[2];
676
c4e3a34e40f1 Added new module dil.doc.Doc.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents:
diff changeset
267 }
c4e3a34e40f1 Added new module dil.doc.Doc.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents:
diff changeset
268
c4e3a34e40f1 Added new module dil.doc.Doc.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents:
diff changeset
269 /++
c4e3a34e40f1 Added new module dil.doc.Doc.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents:
diff changeset
270 Returns the surrounding documentation comment tokens.
c4e3a34e40f1 Added new module dil.doc.Doc.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents:
diff changeset
271 Note: this function works correctly only if
c4e3a34e40f1 Added new module dil.doc.Doc.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents:
diff changeset
272 the source text is syntactically correct.
c4e3a34e40f1 Added new module dil.doc.Doc.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents:
diff changeset
273 +/
714
140469ecb90e Added code and applied fixes.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 712
diff changeset
274 Token*[] getDocTokens(Node node, bool function(Token*) isDocComment = &isDDocComment)
676
c4e3a34e40f1 Added new module dil.doc.Doc.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents:
diff changeset
275 {
c4e3a34e40f1 Added new module dil.doc.Doc.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents:
diff changeset
276 Token*[] comments;
714
140469ecb90e Added code and applied fixes.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 712
diff changeset
277 auto isEnumMember = node.kind == NodeKind.EnumMemberDeclaration;
676
c4e3a34e40f1 Added new module dil.doc.Doc.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents:
diff changeset
278 // Get preceding comments.
c4e3a34e40f1 Added new module dil.doc.Doc.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents:
diff changeset
279 auto token = node.begin;
c4e3a34e40f1 Added new module dil.doc.Doc.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents:
diff changeset
280 // Scan backwards until we hit another declaration.
714
140469ecb90e Added code and applied fixes.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 712
diff changeset
281 Loop:
676
c4e3a34e40f1 Added new module dil.doc.Doc.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents:
diff changeset
282 while (1)
c4e3a34e40f1 Added new module dil.doc.Doc.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents:
diff changeset
283 {
c4e3a34e40f1 Added new module dil.doc.Doc.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents:
diff changeset
284 token = token.prev;
679
ff6971637f88 Renamed Token member type to kind.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 676
diff changeset
285 if (token.kind == TOK.LBrace ||
ff6971637f88 Renamed Token member type to kind.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 676
diff changeset
286 token.kind == TOK.RBrace ||
ff6971637f88 Renamed Token member type to kind.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 676
diff changeset
287 token.kind == TOK.Semicolon ||
ff6971637f88 Renamed Token member type to kind.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 676
diff changeset
288 token.kind == TOK.HEAD ||
714
140469ecb90e Added code and applied fixes.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 712
diff changeset
289 (isEnumMember && token.kind == TOK.Comma))
676
c4e3a34e40f1 Added new module dil.doc.Doc.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents:
diff changeset
290 break;
c4e3a34e40f1 Added new module dil.doc.Doc.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents:
diff changeset
291
679
ff6971637f88 Renamed Token member type to kind.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 676
diff changeset
292 if (token.kind == TOK.Comment)
714
140469ecb90e Added code and applied fixes.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 712
diff changeset
293 { // Check that this comment doesn't belong to the previous declaration.
679
ff6971637f88 Renamed Token member type to kind.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 676
diff changeset
294 switch (token.prev.kind)
676
c4e3a34e40f1 Added new module dil.doc.Doc.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents:
diff changeset
295 {
714
140469ecb90e Added code and applied fixes.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 712
diff changeset
296 case TOK.Semicolon, TOK.RBrace, TOK.Comma:
140469ecb90e Added code and applied fixes.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 712
diff changeset
297 break Loop;
676
c4e3a34e40f1 Added new module dil.doc.Doc.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents:
diff changeset
298 default:
c4e3a34e40f1 Added new module dil.doc.Doc.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents:
diff changeset
299 if (isDocComment(token))
714
140469ecb90e Added code and applied fixes.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 712
diff changeset
300 comments = [token] ~ comments;
676
c4e3a34e40f1 Added new module dil.doc.Doc.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents:
diff changeset
301 }
c4e3a34e40f1 Added new module dil.doc.Doc.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents:
diff changeset
302 }
c4e3a34e40f1 Added new module dil.doc.Doc.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents:
diff changeset
303 }
c4e3a34e40f1 Added new module dil.doc.Doc.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents:
diff changeset
304 // Get single comment to the right.
c4e3a34e40f1 Added new module dil.doc.Doc.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents:
diff changeset
305 token = node.end.next;
679
ff6971637f88 Renamed Token member type to kind.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 676
diff changeset
306 if (token.kind == TOK.Comment && isDocComment(token))
676
c4e3a34e40f1 Added new module dil.doc.Doc.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents:
diff changeset
307 comments ~= token;
714
140469ecb90e Added code and applied fixes.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 712
diff changeset
308 else if (isEnumMember)
676
c4e3a34e40f1 Added new module dil.doc.Doc.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents:
diff changeset
309 {
c4e3a34e40f1 Added new module dil.doc.Doc.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents:
diff changeset
310 token = node.end.nextNWS;
679
ff6971637f88 Renamed Token member type to kind.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 676
diff changeset
311 if (token.kind == TOK.Comma)
676
c4e3a34e40f1 Added new module dil.doc.Doc.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents:
diff changeset
312 {
c4e3a34e40f1 Added new module dil.doc.Doc.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents:
diff changeset
313 token = token.next;
679
ff6971637f88 Renamed Token member type to kind.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 676
diff changeset
314 if (token.kind == TOK.Comment && isDocComment(token))
676
c4e3a34e40f1 Added new module dil.doc.Doc.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents:
diff changeset
315 comments ~= token;
c4e3a34e40f1 Added new module dil.doc.Doc.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents:
diff changeset
316 }
c4e3a34e40f1 Added new module dil.doc.Doc.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents:
diff changeset
317 }
c4e3a34e40f1 Added new module dil.doc.Doc.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents:
diff changeset
318 return comments;
c4e3a34e40f1 Added new module dil.doc.Doc.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents:
diff changeset
319 }
712
f8875ef9a66d Added function sanitize() to dil.doc.Doc.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 680
diff changeset
320
714
140469ecb90e Added code and applied fixes.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 712
diff changeset
321 bool isLineComment(Token* t)
140469ecb90e Added code and applied fixes.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 712
diff changeset
322 {
140469ecb90e Added code and applied fixes.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 712
diff changeset
323 assert(t.kind == TOK.Comment);
140469ecb90e Added code and applied fixes.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 712
diff changeset
324 return t.start[1] == '/';
140469ecb90e Added code and applied fixes.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 712
diff changeset
325 }
140469ecb90e Added code and applied fixes.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 712
diff changeset
326
140469ecb90e Added code and applied fixes.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 712
diff changeset
327 /// Extracts the text body of the comment tokens.
140469ecb90e Added code and applied fixes.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 712
diff changeset
328 string getDDocText(Token*[] tokens)
140469ecb90e Added code and applied fixes.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 712
diff changeset
329 {
737
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
330 if (tokens.length == 0)
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
331 return null;
714
140469ecb90e Added code and applied fixes.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 712
diff changeset
332 string result;
140469ecb90e Added code and applied fixes.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 712
diff changeset
333 foreach (token; tokens)
140469ecb90e Added code and applied fixes.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 712
diff changeset
334 {
140469ecb90e Added code and applied fixes.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 712
diff changeset
335 auto n = isLineComment(token) ? 0 : 2; // 0 for "//", 2 for "+/" and "*/".
140469ecb90e Added code and applied fixes.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 712
diff changeset
336 result ~= sanitize(token.srcText[3 .. $-n], token.start[1]);
737
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
337 assert(token.next);
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
338 if (token.next.kind == TOK.Newline)
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
339 result ~= \n;
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
340 else
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
341 result ~= ' ';
714
140469ecb90e Added code and applied fixes.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 712
diff changeset
342 }
737
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
343 // Stdout.formatln("→{}←", result);
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
344 return result[0..$-1]; // Remove \n or ' '
714
140469ecb90e Added code and applied fixes.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 712
diff changeset
345 }
140469ecb90e Added code and applied fixes.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 712
diff changeset
346
712
f8875ef9a66d Added function sanitize() to dil.doc.Doc.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 680
diff changeset
347 /// Sanitizes a DDoc comment string.
714
140469ecb90e Added code and applied fixes.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 712
diff changeset
348 /// Leading "commentChar"s are removed from the lines.
712
f8875ef9a66d Added function sanitize() to dil.doc.Doc.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 680
diff changeset
349 /// The various newline types are converted to '\n'.
f8875ef9a66d Added function sanitize() to dil.doc.Doc.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 680
diff changeset
350 /// Params:
f8875ef9a66d Added function sanitize() to dil.doc.Doc.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 680
diff changeset
351 /// comment = the string to be sanitized.
f8875ef9a66d Added function sanitize() to dil.doc.Doc.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 680
diff changeset
352 /// commentChar = '/', '+', or '*'
f8875ef9a66d Added function sanitize() to dil.doc.Doc.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 680
diff changeset
353 string sanitize(string comment, char commentChar)
f8875ef9a66d Added function sanitize() to dil.doc.Doc.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 680
diff changeset
354 {
737
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
355 alias comment result;
712
f8875ef9a66d Added function sanitize() to dil.doc.Doc.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 680
diff changeset
356
737
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
357 bool newline = true; // True when at the beginning of a new line.
712
f8875ef9a66d Added function sanitize() to dil.doc.Doc.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 680
diff changeset
358 uint i, j;
737
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
359 auto len = result.length;
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
360 for (; i < len; i++, j++)
712
f8875ef9a66d Added function sanitize() to dil.doc.Doc.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 680
diff changeset
361 {
f8875ef9a66d Added function sanitize() to dil.doc.Doc.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 680
diff changeset
362 if (newline)
f8875ef9a66d Added function sanitize() to dil.doc.Doc.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 680
diff changeset
363 { // Ignore commentChars at the beginning of each new line.
f8875ef9a66d Added function sanitize() to dil.doc.Doc.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 680
diff changeset
364 newline = false;
737
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
365 while (i < len && isspace(result[i]))
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
366 i++;
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
367 while (i < len && result[i] == commentChar)
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
368 i++;
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
369 if (i >= len)
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
370 break;
712
f8875ef9a66d Added function sanitize() to dil.doc.Doc.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 680
diff changeset
371 }
f8875ef9a66d Added function sanitize() to dil.doc.Doc.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 680
diff changeset
372 // Check for Newline.
f8875ef9a66d Added function sanitize() to dil.doc.Doc.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 680
diff changeset
373 switch (result[i])
f8875ef9a66d Added function sanitize() to dil.doc.Doc.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 680
diff changeset
374 {
f8875ef9a66d Added function sanitize() to dil.doc.Doc.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 680
diff changeset
375 case '\r':
737
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
376 if (i+1 < len && result[i+1] == '\n')
712
f8875ef9a66d Added function sanitize() to dil.doc.Doc.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 680
diff changeset
377 i++;
f8875ef9a66d Added function sanitize() to dil.doc.Doc.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 680
diff changeset
378 case '\n':
737
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
379 result[j] = '\n'; // Copy Newline as '\n'.
712
f8875ef9a66d Added function sanitize() to dil.doc.Doc.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 680
diff changeset
380 newline = true;
f8875ef9a66d Added function sanitize() to dil.doc.Doc.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 680
diff changeset
381 continue;
f8875ef9a66d Added function sanitize() to dil.doc.Doc.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 680
diff changeset
382 default:
737
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
383 if (!isascii(result[i]) && i+2 < len && isUnicodeNewline(result.ptr + i))
712
f8875ef9a66d Added function sanitize() to dil.doc.Doc.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 680
diff changeset
384 {
f8875ef9a66d Added function sanitize() to dil.doc.Doc.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 680
diff changeset
385 i++; i++;
f8875ef9a66d Added function sanitize() to dil.doc.Doc.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 680
diff changeset
386 goto case '\n';
f8875ef9a66d Added function sanitize() to dil.doc.Doc.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 680
diff changeset
387 }
f8875ef9a66d Added function sanitize() to dil.doc.Doc.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 680
diff changeset
388 }
f8875ef9a66d Added function sanitize() to dil.doc.Doc.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 680
diff changeset
389 // Copy character.
737
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
390 result[j] = result[i];
712
f8875ef9a66d Added function sanitize() to dil.doc.Doc.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 680
diff changeset
391 }
737
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
392 result.length = j; // Adjust length.
712
f8875ef9a66d Added function sanitize() to dil.doc.Doc.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 680
diff changeset
393 // Lastly, strip trailing commentChars.
737
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
394 if (!result.length)
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
395 return null;
728
41cad5ca4863 Added ParamsSection and MacrosSection.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 722
diff changeset
396 i = result.length;
737
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
397 for (; i && result[i-1] == commentChar; i--)
728
41cad5ca4863 Added ParamsSection and MacrosSection.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 722
diff changeset
398 {}
737
f88b5285b86b Implemented DDocEmitter.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 731
diff changeset
399 result.length = i;
712
f8875ef9a66d Added function sanitize() to dil.doc.Doc.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 680
diff changeset
400 return result;
f8875ef9a66d Added function sanitize() to dil.doc.Doc.
Aziz K?ksal <aziz.koeksal@gmail.com>
parents: 680
diff changeset
401 }