Escape "--" in markdown rendering for GN reference docs.

tools/gn/standard_out.cc

 // Copyright (c) 2013 The Chromium Authors. All rights reserved.
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
 
 #include "tools/gn/standard_out.h"
 
 #include <vector>
 
 #include "base/command_line.h"
 #include "base/logging.h"
+#include "base/strings/string_piece.h"
 #include "base/strings/string_split.h"
+#include "base/strings/string_util.h"
 #include "build/build_config.h"
 #include "tools/gn/switches.h"
 
 #if defined(OS_WIN)
 #include <windows.h>
 #else
 #include <stdio.h>
 #include <unistd.h>
 #endif
 
@@ skipping 95 matching lines @@
         ::SetConsoleTextAttribute(hstdout,
                                   FOREGROUND_BLUE | FOREGROUND_INTENSITY);
         break;
       case DECORATION_YELLOW:
         ::SetConsoleTextAttribute(hstdout,
                                   FOREGROUND_RED | FOREGROUND_GREEN);
         break;
     }
   }
 
-  ::WriteFile(hstdout, output.c_str(), static_cast<DWORD>(output.size()),
-              &written, nullptr);
+  // https://code.google.com/p/gitiles/issues/detail?id=77
+  // Gitiles will replace "--" with an em dash in non-code text.
+  // Figuring out all instances of this might be difficult, but
+  // we can at least escape the instances where this shows up in
+  // a heading.
+  if (is_markdown && dec==DECORATION_YELLOW) {

[brettw, 2015/09/04 18:04:29]

Need spaces around ==

+    std::string tmpstr = output;

[brettw, 2015/09/04 18:04:30]

Why not just do
  if (...) {
    base::ReplaceSubstringsAfterOffset(&output, ...);
  }
  ::WriteFile(...);

[Dirk Pranke, 2015/09/05 01:53:42]

output is a const, so we can't modify it. 

I've uploaded a version that always makes the copy; I doubt the performance
matters in this case.

+    base::ReplaceSubstringsAfterOffset(&tmpstr, 0,
+                                       StringPiece("--"),
+                                       StringPiece("\\--"));

[Dirk Pranke, 2015/09/03 01:04:45]

Is this the best/easiest way to do a "replace all" in a string?

[brettw, 2015/09/04 18:04:29]

Sure, but you can remove the explicit StringPiece constructors and just type
"--"

+    ::WriteFile(hstdout, tmpstr.c_str(), static_cast<DWORD>(tmpstr.size()),
+                &written, nullptr);
+  } else {
+    ::WriteFile(hstdout, output.c_str(), static_cast<DWORD>(output.size()),
+                &written, nullptr);
+  }
 
   if (is_markdown) {
     OutputMarkdownDec(dec);
   } else if (is_console) {
     ::SetConsoleTextAttribute(hstdout, default_attributes);
   }
 }
 
 #else
 
@@ skipping 16 matching lines @@
         break;
       case DECORATION_BLUE:
         WriteToStdOut("\e[34m\e[1m");
         break;
       case DECORATION_YELLOW:
         WriteToStdOut("\e[33m\e[1m");
         break;
     }
   }
 
-  WriteToStdOut(output.data());
+  if (is_markdown && dec==DECORATION_YELLOW) {

[brettw, 2015/09/04 18:04:29]

Ditto

+    std::string tmpstr = output;

[brettw, 2015/09/04 18:04:29]

Ditto

+
+    // https://code.google.com/p/gitiles/issues/detail?id=77
+    // Gitiles will replace "--" with an em dash in non-code text.
+    // Figuring out all instances of this might be difficult, but
+    // we can at least escape the instances where this shows up in
+    // a heading.
+    base::ReplaceSubstringsAfterOffset(&tmpstr, 0,
+                                       base::StringPiece("--"),
+                                       base::StringPiece("\\--"));
+    WriteToStdOut(tmpstr.data());
+  } else {
+    WriteToStdOut(output.data());
+  }
 
   if (is_markdown) {
     OutputMarkdownDec(dec);
   } else if (is_console && dec != DECORATION_NONE) {
     WriteToStdOut("\e[0m");
   }
 }
 
 #endif
 
@@ skipping 80 matching lines @@
       }
     }
 
     OutputString(line + "\n", dec);
   }
 
   if (is_markdown && in_body)
     OutputString("\n```\n");
 }