Source/cmGeneratedFileStream.cxx

   1 /*=========================================================================
   2
   3   Program:   CMake - Cross-Platform Makefile Generator
   4   Module:    $RCSfile: cmGeneratedFileStream.cxx,v $
   5   Language:  C++
   6   Date:      $Date: 2009-06-10 17:03:11 $
   7   Version:   $Revision: 1.21 $
   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 "cmGeneratedFileStream.h"
  18
  19 #include "cmSystemTools.h"
  20
  21 #if defined(CMAKE_BUILD_WITH_CMAKE)
  22 # include <cm_zlib.h>
  23 #endif
  24
  25 //----------------------------------------------------------------------------
  26 cmGeneratedFileStream::cmGeneratedFileStream():
  27   cmGeneratedFileStreamBase(), Stream()
  28 {
  29 }
  30
  31 //----------------------------------------------------------------------------
  32 cmGeneratedFileStream::cmGeneratedFileStream(const char* name, bool quiet):
  33   cmGeneratedFileStreamBase(name),
  34   Stream(TempName.c_str())
  35 {
  36   // Check if the file opened.
  37   if(!*this && !quiet)
  38     {
  39     cmSystemTools::Error("Cannot open file for write: ",
  40                          this->TempName.c_str());
  41     cmSystemTools::ReportLastSystemError("");
  42     }
  43 }
  44
  45 //----------------------------------------------------------------------------
  46 cmGeneratedFileStream::~cmGeneratedFileStream()
  47 {
  48   // This is the first destructor called.  Check the status of the
  49   // stream and give the information to the private base.  Next the
  50   // stream will be destroyed which will close the temporary file.
  51   // Finally the base destructor will be called to replace the
  52   // destination file.
  53   this->Okay = (*this)?true:false;
  54 }
  55
  56 //----------------------------------------------------------------------------
  57 cmGeneratedFileStream&
  58 cmGeneratedFileStream::Open(const char* name, bool quiet, bool binaryFlag)
  59 {
  60   // Store the file name and construct the temporary file name.
  61   this->cmGeneratedFileStreamBase::Open(name);
  62
  63   // Open the temporary output file.
  64   if ( binaryFlag )
  65     {
  66     this->Stream::open(this->TempName.c_str(),
  67                        std::ios::out | std::ios::binary);
  68     }
  69   else
  70     {
  71     this->Stream::open(this->TempName.c_str(), std::ios::out);
  72     }
  73
  74   // Check if the file opened.
  75   if(!*this && !quiet)
  76     {
  77     cmSystemTools::Error("Cannot open file for write: ",
  78                          this->TempName.c_str());
  79     cmSystemTools::ReportLastSystemError("");
  80     }
  81   return *this;
  82 }
  83
  84 //----------------------------------------------------------------------------
  85 bool
  86 cmGeneratedFileStream::Close()
  87 {
  88   // Save whether the temporary output file is valid before closing.
  89   this->Okay = (*this)?true:false;
  90
  91   // Close the temporary output file.
  92   this->Stream::close();
  93
  94   // Remove the temporary file (possibly by renaming to the real file).
  95   return this->cmGeneratedFileStreamBase::Close();
  96 }
  97
  98 //----------------------------------------------------------------------------
  99 void cmGeneratedFileStream::SetCopyIfDifferent(bool copy_if_different)
 100 {
 101   this->CopyIfDifferent = copy_if_different;
 102 }
 103
 104 //----------------------------------------------------------------------------
 105 void cmGeneratedFileStream::SetCompression(bool compression)
 106 {
 107   this->Compress = compression;
 108 }
 109
 110 //----------------------------------------------------------------------------
 111 void cmGeneratedFileStream::SetCompressionExtraExtension(bool ext)
 112 {
 113   this->CompressExtraExtension = ext;
 114 }
 115
 116 //----------------------------------------------------------------------------
 117 cmGeneratedFileStreamBase::cmGeneratedFileStreamBase():
 118   Name(),
 119   TempName(),
 120   CopyIfDifferent(false),
 121   Okay(false),
 122   Compress(false),
 123   CompressExtraExtension(true)
 124 {
 125 }
 126
 127 //----------------------------------------------------------------------------
 128 cmGeneratedFileStreamBase::cmGeneratedFileStreamBase(const char* name):
 129   Name(),
 130   TempName(),
 131   CopyIfDifferent(false),
 132   Okay(false),
 133   Compress(false),
 134   CompressExtraExtension(true)
 135 {
 136   this->Open(name);
 137 }
 138
 139 //----------------------------------------------------------------------------
 140 cmGeneratedFileStreamBase::~cmGeneratedFileStreamBase()
 141 {
 142   this->Close();
 143 }
 144
 145 //----------------------------------------------------------------------------
 146 void cmGeneratedFileStreamBase::Open(const char* name)
 147 {
 148   // Save the original name of the file.
 149   this->Name = name;
 150
 151   // Create the name of the temporary file.
 152   this->TempName = name;
 153 #if defined(__VMS)
 154   this->TempName += "_tmp";
 155 #else
 156   this->TempName += ".tmp";
 157 #endif
 158
 159   // Make sure the temporary file that will be used is not present.
 160   cmSystemTools::RemoveFile(this->TempName.c_str());
 161
 162   std::string dir = cmSystemTools::GetFilenamePath(this->TempName);
 163   cmSystemTools::MakeDirectory(dir.c_str());
 164 }
 165
 166 //----------------------------------------------------------------------------
 167 bool cmGeneratedFileStreamBase::Close()
 168 {
 169   bool replaced = false;
 170
 171   std::string resname = this->Name;
 172   if ( this->Compress && this->CompressExtraExtension )
 173     {
 174     resname += ".gz";
 175     }
 176
 177   // Only consider replacing the destination file if no error
 178   // occurred.
 179   if(!this->Name.empty() &&
 180     this->Okay &&
 181     (!this->CopyIfDifferent ||
 182      cmSystemTools::FilesDiffer(this->TempName.c_str(), resname.c_str())))
 183     {
 184     // The destination is to be replaced.  Rename the temporary to the
 185     // destination atomically.
 186     if ( this->Compress )
 187       {
 188       std::string gzname = this->TempName + ".temp.gz";
 189       if ( this->CompressFile(this->TempName.c_str(), gzname.c_str()) )
 190         {
 191         this->RenameFile(gzname.c_str(), resname.c_str());
 192         }
 193       cmSystemTools::RemoveFile(gzname.c_str());
 194       }
 195     else
 196       {
 197       this->RenameFile(this->TempName.c_str(), resname.c_str());
 198       }
 199
 200     replaced = true;
 201     }
 202
 203   // Else, the destination was not replaced.
 204   //
 205   // Always delete the temporary file. We never want it to stay around.
 206   cmSystemTools::RemoveFile(this->TempName.c_str());
 207
 208   return replaced;
 209 }
 210
 211 //----------------------------------------------------------------------------
 212 #ifdef CMAKE_BUILD_WITH_CMAKE
 213 int cmGeneratedFileStreamBase::CompressFile(const char* oldname,
 214                                             const char* newname)
 215 {
 216   gzFile gf = gzopen(newname, "w");
 217   if ( !gf )
 218     {
 219     return 0;
 220     }
 221   FILE* ifs = fopen(oldname, "r");
 222   if ( !ifs )
 223     {
 224     return 0;
 225     }
 226   size_t res;
 227   const size_t BUFFER_SIZE = 1024;
 228   char buffer[BUFFER_SIZE];
 229   while ( (res = fread(buffer, 1, BUFFER_SIZE, ifs)) > 0 )
 230     {
 231     if ( !gzwrite(gf, buffer, static_cast<int>(res)) )
 232       {
 233       fclose(ifs);
 234       gzclose(gf);
 235       return 0;
 236       }
 237     }
 238   fclose(ifs);
 239   gzclose(gf);
 240   return 1;
 241 }
 242 #else
 243 int cmGeneratedFileStreamBase::CompressFile(const char*, const char*)
 244 {
 245   return 0;
 246 }
 247 #endif
 248
 249 //----------------------------------------------------------------------------
 250 int cmGeneratedFileStreamBase::RenameFile(const char* oldname,
 251                                           const char* newname)
 252 {
 253   return cmSystemTools::RenameFile(oldname, newname);
 254 }
 255
 256 //----------------------------------------------------------------------------
 257 void cmGeneratedFileStream::SetName(const char* fname)
 258 {
 259   if ( !fname )
 260     {
 261     this->Name = "";
 262     return;
 263     }
 264   this->Name = fname;
 265 }