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-04-15 13:57:56 $
   7   Version:   $Revision: 1.20 $
   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   this->TempName += ".tmp";
 154
 155   // Make sure the temporary file that will be used is not present.
 156   cmSystemTools::RemoveFile(this->TempName.c_str());
 157
 158   std::string dir = cmSystemTools::GetFilenamePath(this->TempName);
 159   cmSystemTools::MakeDirectory(dir.c_str());
 160 }
 161
 162 //----------------------------------------------------------------------------
 163 bool cmGeneratedFileStreamBase::Close()
 164 {
 165   bool replaced = false;
 166
 167   std::string resname = this->Name;
 168   if ( this->Compress && this->CompressExtraExtension )
 169     {
 170     resname += ".gz";
 171     }
 172
 173   // Only consider replacing the destination file if no error
 174   // occurred.
 175   if(!this->Name.empty() &&
 176     this->Okay &&
 177     (!this->CopyIfDifferent ||
 178      cmSystemTools::FilesDiffer(this->TempName.c_str(), resname.c_str())))
 179     {
 180     // The destination is to be replaced.  Rename the temporary to the
 181     // destination atomically.
 182     if ( this->Compress )
 183       {
 184       std::string gzname = this->TempName + ".temp.gz";
 185       if ( this->CompressFile(this->TempName.c_str(), gzname.c_str()) )
 186         {
 187         this->RenameFile(gzname.c_str(), resname.c_str());
 188         }
 189       cmSystemTools::RemoveFile(gzname.c_str());
 190       }
 191     else
 192       {
 193       this->RenameFile(this->TempName.c_str(), resname.c_str());
 194       }
 195
 196     replaced = true;
 197     }
 198
 199   // Else, the destination was not replaced.
 200   //
 201   // Always delete the temporary file. We never want it to stay around.
 202   cmSystemTools::RemoveFile(this->TempName.c_str());
 203
 204   return replaced;
 205 }
 206
 207 //----------------------------------------------------------------------------
 208 #ifdef CMAKE_BUILD_WITH_CMAKE
 209 int cmGeneratedFileStreamBase::CompressFile(const char* oldname,
 210                                             const char* newname)
 211 {
 212   gzFile gf = gzopen(newname, "w");
 213   if ( !gf )
 214     {
 215     return 0;
 216     }
 217   FILE* ifs = fopen(oldname, "r");
 218   if ( !ifs )
 219     {
 220     return 0;
 221     }
 222   size_t res;
 223   const size_t BUFFER_SIZE = 1024;
 224   char buffer[BUFFER_SIZE];
 225   while ( (res = fread(buffer, 1, BUFFER_SIZE, ifs)) > 0 )
 226     {
 227     if ( !gzwrite(gf, buffer, static_cast<int>(res)) )
 228       {
 229       fclose(ifs);
 230       gzclose(gf);
 231       return 0;
 232       }
 233     }
 234   fclose(ifs);
 235   gzclose(gf);
 236   return 1;
 237 }
 238 #else
 239 int cmGeneratedFileStreamBase::CompressFile(const char*, const char*)
 240 {
 241   return 0;
 242 }
 243 #endif
 244
 245 //----------------------------------------------------------------------------
 246 int cmGeneratedFileStreamBase::RenameFile(const char* oldname,
 247                                           const char* newname)
 248 {
 249   return cmSystemTools::RenameFile(oldname, newname);
 250 }
 251
 252 //----------------------------------------------------------------------------
 253 void cmGeneratedFileStream::SetName(const char* fname)
 254 {
 255   if ( !fname )
 256     {
 257     this->Name = "";
 258     return;
 259     }
 260   this->Name = fname;
 261 }