Source/cmXMLSafe.cxx

   1 /*=========================================================================
   2
   3   Program:   CMake - Cross-Platform Makefile Generator
   4   Module:    $RCSfile: cmXMLSafe.cxx,v $
   5   Language:  C++
   6   Date:      $Date: 2009-03-02 21:27:50 $
   7   Version:   $Revision: 1.5 $
   8
   9   Copyright (c) 2002 Kitware, Inc., Insight Consortium.  All rights reserved.
  10   See Copyright.txt or http://www.cmake.org/HTML/Copyright.html for details.
  11
  12      This software is distributed WITHOUT ANY WARRANTY; without even
  13      the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
  14      PURPOSE.  See the above copyright notices for more information.
  15
  16 =========================================================================*/
  17 #include "cmXMLSafe.h"
  18
  19 #include <cmsys/ios/iostream>
  20 #include <cmsys/ios/sstream>
  21
  22 #include <string.h>
  23 #include <stdio.h>
  24
  25 //----------------------------------------------------------------------------
  26 cmXMLSafe::cmXMLSafe(const char* s):
  27   Data(s),
  28   Size(static_cast<unsigned long>(strlen(s))),
  29   DoQuotes(true)
  30 {
  31 }
  32
  33 //----------------------------------------------------------------------------
  34 cmXMLSafe::cmXMLSafe(cmsys_stl::string const& s):
  35     Data(s.c_str()),
  36     Size(static_cast<unsigned long>(s.length())),
  37     DoQuotes(true)
  38 {
  39 }
  40
  41 //----------------------------------------------------------------------------
  42 cmXMLSafe& cmXMLSafe::Quotes(bool b)
  43 {
  44   this->DoQuotes = b;
  45   return *this;
  46 }
  47
  48 //----------------------------------------------------------------------------
  49 cmsys_stl::string cmXMLSafe::str()
  50 {
  51   cmsys_ios::ostringstream ss;
  52   ss << *this;
  53   return ss.str();
  54 }
  55
  56 //----------------------------------------------------------------------------
  57 cmsys_ios::ostream& operator<<(cmsys_ios::ostream& os, cmXMLSafe const& self)
  58 {
  59   char const* first = self.Data;
  60   char const* last = self.Data + self.Size;
  61   for(char const* ci = first; ci != last; ++ci)
  62     {
  63     unsigned char c = static_cast<unsigned char>(*ci);
  64     switch(c)
  65       {
  66       case '&': os << "&amp;"; break;
  67       case '<': os << "&lt;"; break;
  68       case '>': os << "&gt;"; break;
  69       case '"': os << (self.DoQuotes? "&quot;" : "\""); break;
  70       case '\'': os << (self.DoQuotes? "&apos;" : "'"); break;
  71       case '\t': os << "\t"; break;
  72       case '\n': os << "\n"; break;
  73       case '\r': break; // Ignore CR
  74       default:
  75         if(c >= 0x20 && c <= 0x7f)
  76           {
  77           os.put(static_cast<char>(c));
  78           }
  79         else
  80           {
  81           // TODO: More complete treatment of program output character
  82           // encoding.  Instead of escaping these bytes, we should
  83           // handle the current locale and its encoding.
  84           char buf[16];
  85           // http://www.w3.org/TR/REC-xml/#NT-Char
  86           if(c >= 0x80)
  87             {
  88             sprintf(buf, "&#x%hx;", static_cast<unsigned short>(c));
  89             }
  90           else
  91             {
  92             // We cannot use "&#x%hx;" here because this value is not
  93             // valid in XML.  Instead use a human-readable hex value.
  94             sprintf(buf, "&lt;0x%hx&gt;", static_cast<unsigned short>(c));
  95             }
  96           os << buf;
  97           }
  98         break;
  99       }
 100     }
 101   return os;
 102 }