Merge pull request #41 from WebFreak001/fix-unknown-2

Add option to leave unknown macros 2
merged-on-behalf-of: Jan Jurzitza <gh@webfreak.org>

Author: dlang-bot

src/ddoc/comments.d

@@ -7,7 +7,7 @@ module ddoc.comments;
 import ddoc.sections;
 import ddoc.lexer;
 
-Comment parseComment(string text, string[string] macros)
+Comment parseComment(string text, string[string] macros, bool removeUnknown = true)
 out(retVal)
 {
 	assert(retVal.sections.length >= 2);
@@ -39,13 +39,13 @@ body
 		if (!doMapping(p[0]))
 			throw new DdocParseException("Unable to parse Key/Value pairs", p[0].content);
 		foreach (ref kv; p[0].mapping)
-			kv[1] = expand(Lexer(highlight(kv[1])), sMacros);
+			kv[1] = expand(Lexer(highlight(kv[1])), sMacros, removeUnknown);
 	}
 
 	foreach (ref Section sec; sections)
 	{
 		if (sec.name != "Macros" && sec.name != "Escapes" && sec.name != "Params")
-			sec.content = expand(Lexer(highlight(sec.content)), sMacros);
+			sec.content = expand(Lexer(highlight(sec.content)), sMacros, removeUnknown);
 	}
 	return Comment(sections);
 }
@@ -104,6 +104,30 @@ Returns:
 	assert(c.sections[3].name == "Returns");
 }
 
+unittest
+{
+	auto macros = ["A" : "<a href=\"$0\">"];
+	auto comment = `Best $(Unknown comment) ever`;
+
+	Comment c = parseComment(comment, macros, true);
+
+	assert(c.sections.length >= 1);
+	assert(c.sections[0].name is null);
+	assert(c.sections[0].content == "Best  ever", c.sections[0].content);
+}
+
+unittest
+{
+	auto macros = ["A" : "<a href=\"$0\">"];
+	auto comment = `Best $(Unknown comment) ever`;
+
+	Comment c = parseComment(comment, macros, false);
+
+	assert(c.sections.length >= 1);
+	assert(c.sections[0].name is null);
+	assert(c.sections[0].content == "Best $(Unknown comment) ever", c.sections[0].content);
+}
+
 unittest
 {
 	auto comment = `---

src/ddoc/macros.d

@@ -167,6 +167,7 @@ shared static this()
  *		DDOC. Which means if an user provides a macro such as $(D macros["B"] = "<h1>$0</h1>";),
  *		it will be used, otherwise the default $(D macros["B"] = "<b>$0</b>";) will be used.
  *		To undefine hardwired macros, just set them to an empty string: $(D macros["B"] = "";).
+ * removeUnknown = Set to true to make unknown macros disappear from the output or false to make them output unprocessed.
  * output = An object satisfying $(D std.range.isOutputRange), usually a $(D std.array.Appender).
  */
 void expand(O)(Lexer input, in string[string] macros, O output, bool removeUnknown = true) if (isOutputRange!(O,

src/ddoc/standalone.d

@@ -43,7 +43,7 @@ string parseFile(string path, in string[string] context) {
 	return parseDdocBody(macros);
 }
 
-string parseDDString(string text, string[string] macros)
+string parseDDString(string text, string[string] macros, bool removeUnknown = true)
 {
 	import ddoc.highlight;
 	import std.string : strip;
@@ -64,29 +64,33 @@ string parseDDString(string text, string[string] macros)
 	//	macros["COPYRIGHT"] = copyright;
 	text = highlight(text);
 	auto lexer = Lexer(text, true);
-	return expand(lexer, macros);
+	return expand(lexer, macros, removeUnknown);
 }
 
 ///
 unittest {
 	import std.stdio, std.string;
 
 	auto text = `Ddoc
-	This file is a standalone Ddoc file. It can contain any kind of
+	This file is a $(unknown standalone) Ddoc file. It can contain any kind of
 	$(MAC macros), defined in the $(MAC 'Macros:' section).
 
 Macros:
 	MAC=$0
 	_=
 `;
 
-	auto expected = `This file is a standalone Ddoc file. It can contain any kind of
+	auto expected1 = `This file is a  Ddoc file. It can contain any kind of
+	macros, defined in the 'Macros:' section.`;
+	auto expected2 = `This file is a $(unknown standalone) Ddoc file. It can contain any kind of
 	macros, defined in the 'Macros:' section.`;
 
 	auto lex = Lexer(text, true);
 	// Whitespace and newline before / after not taken into account.
 	auto res = parseDDString(text, null).strip;
-	assert(res == expected, res);
+	assert(res == expected1, res);
+	res = parseDDString(text, null, false).strip;
+	assert(res == expected2, res);
 }
 
 // Warning: Does not support embedded code / inlining.