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

annotate trunk/src/cmd/DDoc.d @ 799:fd719161e743

New ddoc emitter for XML type output.

author	Jari-Matti M?kel? <jmjm@iki.fi>
date	Sat, 01 Mar 2008 18:04:29 +0200
parents	57ef69eced96
children	dcd30b0ba711

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

Mercurial > projects > dil

annotate trunk/src/cmd/DDoc.d @ 799:fd719161e743