ENH: Create cmXMLSafe to help escapes in XML

This class provides easy syntax to efficiently insert blocks of data
into XML documents with proper escapes.  It replaces the old
cmCTest::MakeXMLSafe and cmSystemTools::MakeXMLSafe methods which
allocated extra memory instead of directly streaming the data.

1 files changed, 93 insertions, 0 deletions

diff --git a/Source/cmXMLSafe.cxx b/Source/cmXMLSafe.cxx
new file mode 100644
index 0000000000..861d75c0b9
--- /dev/null
+++ b/Source/cmXMLSafe.cxx
@@ -0,0 +1,93 @@
+/*=========================================================================
+
+  Program:   CMake - Cross-Platform Makefile Generator
+  Module:    $RCSfile$
+  Language:  C++
+  Date:      $Date$
+  Version:   $Revision$
+
+  Copyright (c) 2002 Kitware, Inc., Insight Consortium.  All rights reserved.
+  See Copyright.txt or http://www.cmake.org/HTML/Copyright.html for details.
+
+     This software is distributed WITHOUT ANY WARRANTY; without even
+     the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
+     PURPOSE.  See the above copyright notices for more information.
+
+=========================================================================*/
+#include "cmXMLSafe.h"
+
+#include <cmsys/ios/iostream>
+#include <cmsys/ios/sstream>
+
+#include <string.h>
+#include <stdio.h>
+
+//----------------------------------------------------------------------------
+cmXMLSafe::cmXMLSafe(const char* s):
+  Data(s),
+  Size(static_cast<unsigned long>(strlen(s))),
+  DoQuotes(true)
+{
+}
+
+//----------------------------------------------------------------------------
+cmXMLSafe::cmXMLSafe(cmsys_stl::string const& str):
+    Data(str.c_str()),
+    Size(static_cast<unsigned long>(str.length())),
+    DoQuotes(true)
+{
+}
+
+//----------------------------------------------------------------------------
+cmXMLSafe& cmXMLSafe::Quotes(bool b)
+{
+  this->DoQuotes = b;
+  return *this;
+}
+
+//----------------------------------------------------------------------------
+cmsys_stl::string cmXMLSafe::str()
+{
+  cmsys_ios::ostringstream ss;
+  ss << *this;
+  return ss.str();
+}
+
+//----------------------------------------------------------------------------
+cmsys_ios::ostream& operator<<(cmsys_ios::ostream& os, cmXMLSafe const& self)
+{
+  char const* first = self.Data;
+  char const* last = self.Data + self.Size;
+  for(char const* ci = first; ci != last; ++ci)
+    {
+    char c = *ci;
+    switch(c)
+      {
+      case '&': os << "&amp;"; break;
+      case '<': os << "&lt;"; break;
+      case '>': os << "&gt;"; break;
+      case '"': os << (self.DoQuotes? "&quot;" : "\""); break;
+      case '\'': os << (self.DoQuotes? "&apos;" : "'"); break;
+      case '\t': os << "\t"; break;
+      case '\n': os << "\n"; break;
+      case '\r': break; // Ignore CR
+      default:
+        if(c >= 0x20 && c <= 0x7f)
+          {
+          os.put(c);
+          }
+        else
+          {
+          // TODO: More complete treatment of program output character
+          // encoding.  Instead of escaping these bytes, we should
+          // handle the current locale and its encoding.
+          unsigned char uc = static_cast<unsigned char>(c);
+          char buf[16];
+          sprintf(buf, "&#x%hx;", static_cast<unsigned short>(uc));
+          os << buf;
+          }
+        break;
+      }
+    }
+  return os;
+}