projects/dil: trunk/src/cmd/DDoc.d annotate

annotate trunk/src/cmd/DDoc.d @ 783:8380fb2c765f

Added documentation comments.

author	Aziz K?ksal <aziz.koeksal@gmail.com>
date	Sat, 23 Feb 2008 02:15:41 +0100
parents	8e6fed11bb68
children	57ef69eced96

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

Mercurial > projects > dil

annotate trunk/src/cmd/DDoc.d @ 783:8380fb2c765f