Src/DiffTextBuffer.cpp

   1 /**
   2  * @file  DiffTextBuffer.cpp
   3  *
   4  * @brief Implementation file for CDiffTextBuffer
   5  *
   6  */
   7 // ID line follows -- this is updated by SVN
   8 // $Id: DiffTextBuffer.cpp 7082 2010-01-03 22:15:50Z sdottaka $
   9
  10 #include "StdAfx.h"
  11 #include "UniFile.h"
  12 #include "files.h"
  13 #include "cs2cs.h"
  14 #include "locality.h"
  15 #include "coretools.h"
  16 #include "Merge.h"
  17 #include "OptionsDef.h"
  18 #include "Environment.h"
  19 #include "MergeLineFlags.h"
  20 #include "MergeDoc.h"
  21 #include "FileTransform.h"
  22 #include "FileTextEncoding.h"
  23 #include "DiffTextBuffer.h"
  24 #include "codepage_detect.h"
  25
  26 #ifdef _DEBUG
  27 #define new DEBUG_NEW
  28 #undef THIS_FILE
  29 static char THIS_FILE[] = __FILE__;
  30 #endif
  31
  32 static bool IsTextFileStylePure(const UniMemFile::txtstats & stats);
  33 static CString GetLineByteTimeReport(UINT lines, __int64 bytes,
  34         const COleDateTime & start);
  35 static void EscapeControlChars(CString &s);
  36 static LPCTSTR GetEol(const CString &str);
  37 static CRLFSTYLE GetTextFileStyle(const UniMemFile::txtstats & stats);
  38
  39 /**
  40  * @brief Check if file has only one EOL type.
  41  * @param [in] stats File's text stats.
  42  * @return true if only one EOL type is found, false otherwise.
  43  */
  44 static bool IsTextFileStylePure(const UniMemFile::txtstats & stats)
  45 {
  46         int nType = 0;
  47         if (stats.ncrlfs > 0)
  48                 nType++;
  49         if ( stats.ncrs > 0)
  50                 nType++;
  51         if (stats.nlfs > 0)
  52                 nType++;
  53         return (nType <= 1);
  54 }
  55
  56 /**
  57  * @brief Return a string giving #lines and #bytes and how much time elapsed.
  58  * @param [in] lines Count of lines.
  59  * @param [in] bytes Count of bytes.
  60  * @param [in] start Time used.
  61  * @return Formatted string.
  62  */
  63 static CString GetLineByteTimeReport(UINT lines, __int64 bytes,
  64         const COleDateTime & start)
  65 {
  66         String sLines = locality::NumToLocaleStr((int)lines);
  67         String sBytes = locality::NumToLocaleStr(bytes);
  68         COleDateTimeSpan duration = COleDateTime::GetCurrentTime() - start;
  69         String sMinutes = locality::NumToLocaleStr((int)duration.GetTotalMinutes());
  70         CString str;
  71         str.Format(_T("%s lines (%s byte) saved in %sm%02ds")
  72                 , sLines.c_str(), sBytes.c_str(), sMinutes.c_str()
  73                 , duration.GetSeconds()
  74                 );
  75         return str;
  76 }
  77
  78 /**
  79  * @brief Escape control characters.
  80  * @param [in,out] s Line of text excluding eol chars.
  81  *
  82  * @note Escape sequences follow the pattern
  83  * (leadin character, high nibble, low nibble, leadout character).
  84  * The leadin character is '\x0F'. The leadout character is a backslash.
  85  */
  86 static void EscapeControlChars(CString &s)
  87 {
  88         // Compute buffer length required for escaping
  89         int n = s.GetLength();
  90         LPCTSTR q = s;
  91         int i = n;
  92         while (i)
  93         {
  94                 TCHAR c = q[--i];
  95                 // Is it a control character in the range 0..31 except TAB?
  96                 if (!(c & ~_T('\x1F')) && c != _T('\t'))
  97                 {
  98                         n += 3; // Need 3 extra characters to escape
  99                 }
 100         }
 101         // Reallocate accordingly
 102         i = s.GetLength();
 103         LPTSTR p = s.GetBufferSetLength(n);
 104         // Copy/translate characters starting at end of string
 105         while (i)
 106         {
 107                 TCHAR c = p[--i];
 108                 // Is it a control character in the range 0..31 except TAB?
 109                 if (!(c & ~_T('\x1F')) && c != _T('\t'))
 110                 {
 111                         // Bitwise OR with 0x100 so _itot() will output 3 hex digits
 112                         _itot(0x100 | c, p + n - 4, 16);
 113                         // Replace terminating zero with leadout character
 114                         p[n - 1] = _T('\\');
 115                         // Prepare to replace 1st hex digit with leadin character
 116                         c = _T('\x0F');
 117                         n -= 3;
 118                 }
 119                 p[--n] = c;
 120         }
 121 }
 122
 123 /**
 124  * @brief Get file's EOL type.
 125  * @param [in] stats File's text stats.
 126  * @return EOL type.
 127  */
 128 static CRLFSTYLE GetTextFileStyle(const UniMemFile::txtstats & stats)
 129 {
 130         // Check if file has more than one EOL type.
 131         if (!IsTextFileStylePure(stats))
 132                         return CRLF_STYLE_MIXED;
 133         else if (stats.ncrlfs >= stats.nlfs)
 134         {
 135                 if (stats.ncrlfs >= stats.ncrs)
 136                         return CRLF_STYLE_DOS;
 137                 else
 138                         return CRLF_STYLE_MAC;
 139         }
 140         else
 141         {
 142                 if (stats.nlfs >= stats.ncrs)
 143                         return CRLF_STYLE_UNIX;
 144                 else
 145                         return CRLF_STYLE_MAC;
 146         }
 147 }
 148
 149 /**
 150  * @brief Constructor.
 151  * @param [in] pDoc Owning CMergeDoc.
 152  * @param [in] pane Pane number this buffer is associated with.
 153  */
 154 CDiffTextBuffer::CDiffTextBuffer(CMergeDoc * pDoc, int pane)
 155 : m_pOwnerDoc(pDoc)
 156 , m_nThisPane(pane)
 157 , m_unpackerSubcode(0)
 158 , m_bMixedEOL(false)
 159 {
 160 }
 161
 162 /**
 163  * @brief Get a line from the buffer.
 164  * @param [in] nLineIndex Index of the line to get.
 165  * @param [out] strLine Returns line text in the index.
 166  */
 167 BOOL CDiffTextBuffer::GetLine(int nLineIndex, CString &strLine) const
 168 {
 169         int nLineLength = CCrystalTextBuffer::GetLineLength(nLineIndex);
 170         if (nLineLength < 0)
 171                 return FALSE;
 172         else if (nLineLength == 0)
 173                 strLine.Empty();
 174         else
 175         {
 176                 _tcsncpy(strLine.GetBuffer(nLineLength + 1),
 177                         CCrystalTextBuffer::GetLineChars(nLineIndex), nLineLength);
 178                 strLine.ReleaseBuffer(nLineLength);
 179         }
 180         return TRUE;
 181 }
 182
 183 /**
 184  * @brief Set the buffer modified status.
 185  * @param [in] bModified New modified status, TRUE if buffer has been
 186  *   modified since last saving.
 187  */
 188 void CDiffTextBuffer::SetModified(BOOL bModified /*= TRUE*/)
 189 {
 190         CCrystalTextBuffer::SetModified (bModified);
 191         m_pOwnerDoc->SetModifiedFlag (bModified);
 192 }
 193
 194 /**
 195  * @brief Get a line (with EOL bytes) from the buffer.
 196  * This function is like GetLine() but it also includes line's EOL to the
 197  * returned string.
 198  * @param [in] nLineIndex Index of the line to get.
 199  * @param [out] strLine Returns line text in the index. Existing content
 200  * of this string is overwritten.
 201  */
 202 BOOL CDiffTextBuffer::GetFullLine(int nLineIndex, CString &strLine) const
 203 {
 204         int cchText = GetFullLineLength(nLineIndex);
 205         if (cchText == 0)
 206         {
 207                 strLine.Empty();
 208                 return FALSE;
 209         }
 210         LPTSTR pchText = strLine.GetBufferSetLength(cchText);
 211         memcpy(pchText, GetLineChars(nLineIndex), cchText * sizeof(TCHAR));
 212         return TRUE;
 213 }
 214
 215 void CDiffTextBuffer::AddUndoRecord(BOOL bInsert, const CPoint & ptStartPos,
 216                 const CPoint & ptEndPos, LPCTSTR pszText, int cchText,
 217                 int nLinesToValidate, int nActionType /*= CE_ACTION_UNKNOWN*/,
 218                 CDWordArray *paSavedRevisonNumbers)
 219 {
 220         CGhostTextBuffer::AddUndoRecord(bInsert, ptStartPos, ptEndPos, pszText,
 221                 cchText, nLinesToValidate, nActionType, paSavedRevisonNumbers);
 222         if (m_aUndoBuf[m_nUndoPosition - 1].m_dwFlags & UNDO_BEGINGROUP)
 223         {
 224                 m_pOwnerDoc->undoTgt.erase(m_pOwnerDoc->curUndo, m_pOwnerDoc->undoTgt.end());
 225                 m_pOwnerDoc->undoTgt.push_back(m_pOwnerDoc->GetView(m_nThisPane));
 226                 m_pOwnerDoc->curUndo = m_pOwnerDoc->undoTgt.end();
 227         }
 228 }
 229 /**
 230  * @brief Checks if a flag is set for line.
 231  * @param [in] line Index (0-based) for line.
 232  * @param [in] flag Flag to check.
 233  * @return TRUE if flag is set, FALSE otherwise.
 234  */
 235 BOOL CDiffTextBuffer::FlagIsSet(UINT line, DWORD flag) const
 236 {
 237         return ((m_aLines[line].m_dwFlags & flag) == flag);
 238 }
 239
 240 /**
 241 Remove blank lines and clear winmerge flags
 242 (2003-06-21, Perry: I don't understand why this is necessary, but if this isn't
 243 done, more and more gray lines appear in the file)
 244 (2003-07-31, Laoran I don't understand either why it is necessary, but it works
 245 fine, so let's go on with it)
 246 */
 247 void CDiffTextBuffer::prepareForRescan()
 248 {
 249         RemoveAllGhostLines();
 250         for (int ct = GetLineCount() - 1; ct >= 0; --ct)
 251         {
 252                 SetLineFlag(ct,
 253                         LF_INVISIBLE | LF_DIFF | LF_TRIVIAL | LF_MOVED | LF_SNP,
 254                         FALSE, FALSE, FALSE);
 255         }
 256 }
 257
 258 /**
 259  * @brief Called when line has been edited.
 260  * After editing a line, we don't know if there is a diff or not.
 261  * So we clear the LF_DIFF flag (and it is more easy to read during edition).
 262  * Rescan will set the proper color.
 263  * @param [in] nLine Line that has been edited.
 264  */
 265
 266 void CDiffTextBuffer::OnNotifyLineHasBeenEdited(int nLine)
 267 {
 268         SetLineFlag(nLine, LF_DIFF, FALSE, FALSE, FALSE);
 269         SetLineFlag(nLine, LF_TRIVIAL, FALSE, FALSE, FALSE);
 270         SetLineFlag(nLine, LF_MOVED, FALSE, FALSE, FALSE);
 271         SetLineFlag(nLine, LF_SNP, FALSE, FALSE, FALSE);
 272         CGhostTextBuffer::OnNotifyLineHasBeenEdited(nLine);
 273 }
 274
 275 /**
 276  * @brief Set the folder for temp files.
 277  * @param [in] path Temp files folder.
 278  */
 279 void CDiffTextBuffer::SetTempPath(const String &path)
 280 {
 281         m_strTempPath = path;
 282 }
 283
 284 /**
 285  * @brief Is the buffer initialized?
 286  * @return TRUE if the buffer is initialized, FALSE otherwise.
 287  */
 288 bool CDiffTextBuffer::IsInitialized() const
 289 {
 290         return !!m_bInit;
 291 }
 292
 293 /**
 294  * @brief Load file from disk into buffer
 295  *
 296  * @param [in] pszFileNameInit File to load
 297  * @param [in] infoUnpacker Unpacker plugin
 298  * @param [in] sToFindUnpacker String for finding unpacker plugin
 299  * @param [out] readOnly Loading was lossy so file should be read-only
 300  * @param [in] nCrlfStyle EOL style used
 301  * @param [in] encoding Encoding used
 302  * @param [out] sError Error message returned
 303  * @return FRESULT_OK when loading succeed or (list in files.h):
 304  * - FRESULT_OK_IMPURE : load OK, but the EOL are of different types
 305  * - FRESULT_ERROR_UNPACK : plugin failed to unpack
 306  * - FRESULT_ERROR : loading failed, sError contains error message
 307  * - FRESULT_BINARY : file is binary file
 308  * @note If this method fails, it calls InitNew so the CDiffTextBuffer is in a valid state
 309  */
 310 int CDiffTextBuffer::LoadFromFile(LPCTSTR pszFileNameInit,
 311                 PackingInfo * infoUnpacker, LPCTSTR sToFindUnpacker, BOOL & readOnly,
 312                 CRLFSTYLE nCrlfStyle, const FileTextEncoding & encoding, CString &sError)
 313 {
 314         ASSERT(!m_bInit);
 315         ASSERT(m_aLines.size() == 0);
 316
 317         // Unpacking the file here, save the result in a temporary file
 318         String sFileName(pszFileNameInit);
 319         if (infoUnpacker->bToBeScanned)
 320         {
 321                 if (!FileTransform_Unpacking(sFileName, sToFindUnpacker, infoUnpacker,
 322                         &m_unpackerSubcode))
 323                 {
 324                         InitNew(); // leave crystal editor in valid, empty state
 325                         return FileLoadResult::FRESULT_ERROR_UNPACK;
 326                 }
 327         }
 328         else
 329         {
 330                 if (!FileTransform_Unpacking(sFileName, infoUnpacker, &m_unpackerSubcode))
 331                 {
 332                         InitNew(); // leave crystal editor in valid, empty state
 333                         return FileLoadResult::FRESULT_ERROR_UNPACK;
 334                 }
 335         }
 336         // we use the same unpacker for both files, so it must be defined after first file
 337         ASSERT(infoUnpacker->bToBeScanned != PLUGIN_AUTO);
 338         // we will load the transformed file
 339         LPCTSTR pszFileName = sFileName.c_str();
 340
 341         String sExt;
 342         DWORD nRetVal = FileLoadResult::FRESULT_OK;
 343
 344         // Set encoding based on extension, if we know one
 345         SplitFilename(pszFileName, NULL, NULL, &sExt);
 346         CCrystalTextView::TextDefinition *def =
 347                 CCrystalTextView::GetTextType(sExt.c_str());
 348         if (def && def->encoding != -1)
 349                 m_nSourceEncoding = def->encoding;
 350
 351         UniFile *pufile = infoUnpacker->pufile;
 352         if (pufile == 0)
 353                 pufile = new UniMemFile;
 354
 355         // Now we only use the UniFile interface
 356         // which is something we could implement for HTTP and/or FTP files
 357
 358         if (!pufile->OpenReadOnly(pszFileName))
 359         {
 360                 nRetVal = FileLoadResult::FRESULT_ERROR;
 361                 UniFile::UniError uniErr = pufile->GetLastUniError();
 362                 if (uniErr.HasError())
 363                 {
 364                         sError = uniErr.GetError().c_str();
 365                 }
 366                 InitNew(); // leave crystal editor in valid, empty state
 367                 goto LoadFromFileExit;
 368         }
 369         else
 370         {
 371                 if (infoUnpacker->pluginName.length() == 0)
 372                 {
 373                         // re-detect codepage
 374                         FileTextEncoding encoding2;
 375                         int iGuessEncodingType = GetOptionsMgr()->GetInt(OPT_CP_DETECT);
 376                         GuessCodepageEncoding(pszFileName, &encoding2,
 377                                 iGuessEncodingType);
 378                         pufile->SetUnicoding(encoding2.m_unicoding);
 379                         pufile->SetCodepage(encoding2.m_codepage);
 380                         pufile->SetBom(encoding2.m_bom);
 381                 }
 382                 else
 383                 {
 384                         // If the file is not unicode file, use the codepage we were given to
 385                         // interpret the 8-bit characters. If the file is unicode file,
 386                         // determine its type (IsUnicode() does that).
 387                         if (encoding.m_unicoding == ucr::NONE  || !pufile->IsUnicode())
 388                                 pufile->SetCodepage(encoding.m_codepage);
 389                 }
 390                 UINT lineno = 0;
 391                 String eol, preveol;
 392                 String sline;
 393                 bool done = false;
 394                 UINT next_line_report = 100; // for trace messages
 395                 UINT next_line_multiple = 5; // for trace messages
 396                 COleDateTime start = COleDateTime::GetCurrentTime(); // for trace messages
 397
 398                 // Manually grow line array exponentially
 399                 UINT arraysize = 500;
 400                 m_aLines.resize(arraysize);
 401
 402                 // preveol must be initialized for empty files
 403                 preveol = _T("\n");
 404
 405                 do {
 406                         bool lossy = false;
 407                         done = !pufile->ReadString(sline, eol, &lossy);
 408
 409                         // if last line had no eol, we can quit
 410                         if (done && preveol.empty())
 411                                 break;
 412                         // but if last line had eol, we add an extra (empty) line to buffer
 413
 414                         // Grow line array
 415                         if (lineno == arraysize)
 416                         {
 417                                 // For smaller sizes use exponential growth, but for larger
 418                                 // sizes grow by constant ratio. Unlimited exponential growth
 419                                 // easily runs out of memory.
 420                                 if (arraysize < 100 * 1024)
 421                                         arraysize *= 2;
 422                                 else
 423                                         arraysize += 100 * 1024;
 424                                 m_aLines.resize(arraysize);
 425                         }
 426
 427                         sline += eol; // TODO: opportunity for optimization, as CString append is terrible
 428                         if (lossy)
 429                         {
 430                                 // TODO: Should record lossy status of line
 431                         }
 432                         AppendLine(lineno, sline.c_str(), sline.length());
 433                         ++lineno;
 434                         preveol = eol;
 435
 436 #ifdef _DEBUG
 437                         // send occasional line counts to trace
 438                         // (at 100, 500, 1000, 5000, etc)
 439                         if (lineno == next_line_report)
 440                         {
 441                                 __int64 dwBytesRead = pufile->GetPosition();
 442                                 COleDateTimeSpan duration = COleDateTime::GetCurrentTime() - start;
 443                                 if (duration.GetTotalMinutes() > 0)
 444                                 {
 445                                         CString strace = GetLineByteTimeReport(lineno, dwBytesRead, start);
 446                                         TRACE(_T("%s\n"), (LPCTSTR)strace);
 447                                 }
 448                                 next_line_report = next_line_multiple * next_line_report;
 449                                 next_line_multiple = (next_line_multiple == 5) ? 2 : 5;
 450                         }
 451 #endif // _DEBUG
 452                 } while (!done);
 453
 454 #ifdef _DEBUG
 455                 // Send report of duration to trace (if it took a while)
 456                 COleDateTime end = COleDateTime::GetCurrentTime();
 457                 COleDateTimeSpan duration = end - start;
 458                 if (duration.GetTotalMinutes() > 0)
 459                 {
 460                         __int64 dwBytesRead = pufile->GetPosition();
 461                         CString strace = GetLineByteTimeReport(lineno, dwBytesRead, start);
 462                         TRACE(_T("%s\n"), (LPCTSTR)strace);
 463                 }
 464 #endif // _DEBUG
 465
 466                 // fix array size (due to our manual exponential growth
 467                 m_aLines.resize(lineno);
 468
 469
 470                 //Try to determine current CRLF mode (most frequent)
 471                 if (nCrlfStyle == CRLF_STYLE_AUTOMATIC)
 472                 {
 473                         nCrlfStyle = GetTextFileStyle(pufile->GetTxtStats());
 474                 }
 475                 ASSERT(nCrlfStyle >= 0 && nCrlfStyle <= 3);
 476                 SetCRLFMode(nCrlfStyle);
 477
 478                 //  At least one empty line must present
 479                 // (view does not work for empty buffers)
 480                 ASSERT(m_aLines.size() > 0);
 481
 482                 m_bInit = TRUE;
 483                 m_bModified = FALSE;
 484                 m_bUndoGroup = m_bUndoBeginGroup = FALSE;
 485                 m_nSyncPosition = m_nUndoPosition = 0;
 486                 ASSERT(m_aUndoBuf.size() == 0);
 487                 m_ptLastChange.x = m_ptLastChange.y = -1;
 488
 489                 FinishLoading();
 490                 // flags don't need initialization because 0 is the default value
 491
 492                 // Set the return value : OK + info if the file is impure
 493                 // A pure file is a file where EOL are consistent (all DOS, or all UNIX, or all MAC)
 494                 // An impure file is a file with several EOL types
 495                 // WinMerge may display impure files, but the default option is to unify the EOL
 496                 // We return this info to the caller, so it may display a confirmation box
 497                 if (IsTextFileStylePure(pufile->GetTxtStats()))
 498                         nRetVal = FileLoadResult::FRESULT_OK;
 499                 else
 500                         nRetVal = FileLoadResult::FRESULT_OK_IMPURE;
 501
 502                 // stash original encoding away
 503                 m_encoding.m_unicoding = pufile->GetUnicoding();
 504                 m_encoding.m_bom = pufile->HasBom();
 505                 m_encoding.m_codepage = pufile->GetCodepage();
 506
 507                 if (pufile->GetTxtStats().nlosses)
 508                 {
 509                         FileLoadResult::AddModifier(nRetVal, FileLoadResult::FRESULT_LOSSY);
 510                         readOnly = TRUE;
 511                 }
 512         }
 513
 514 LoadFromFileExit:
 515         // close the file now to free the handle
 516         pufile->Close();
 517         delete pufile;
 518
 519         // delete the file that unpacking may have created
 520         if (_tcscmp(pszFileNameInit, pszFileName) != 0)
 521                 if (!::DeleteFile(pszFileName))
 522                 {
 523                         LogErrorString(Fmt(_T("DeleteFile(%s) failed: %s"),
 524                                 pszFileName, GetSysError(GetLastError()).c_str()));
 525                 }
 526
 527         return nRetVal;
 528 }
 529
 530 /**
 531  * @brief Saves file from buffer to disk
 532  *
 533  * @param bTempFile : FALSE if we are saving user files and
 534  * TRUE if we are saving workin-temp-files for diff-engine
 535  *
 536  * @return SAVE_DONE or an error code (list in MergeDoc.h)
 537  */
 538 int CDiffTextBuffer::SaveToFile (LPCTSTR pszFileName,
 539                 BOOL bTempFile, String & sError, PackingInfo * infoUnpacker /*= NULL*/,
 540                 CRLFSTYLE nCrlfStyle /*= CRLF_STYLE_AUTOMATIC*/,
 541                 BOOL bClearModifiedFlag /*= TRUE*/,
 542                 BOOL bForceUTF8 /*= FALSE*/)
 543 {
 544         ASSERT (nCrlfStyle == CRLF_STYLE_AUTOMATIC || nCrlfStyle == CRLF_STYLE_DOS ||
 545                 nCrlfStyle == CRLF_STYLE_UNIX || nCrlfStyle == CRLF_STYLE_MAC);
 546         ASSERT (m_bInit);
 547
 548         if (!pszFileName || _tcslen(pszFileName) == 0)
 549                 return SAVE_FAILED;     // No filename, cannot save...
 550
 551         if (nCrlfStyle == CRLF_STYLE_AUTOMATIC &&
 552                 !GetOptionsMgr()->GetBool(OPT_ALLOW_MIXED_EOL) ||
 553                 infoUnpacker && infoUnpacker->disallowMixedEOL)
 554         {
 555                         // get the default nCrlfStyle of the CDiffTextBuffer
 556                 nCrlfStyle = GetCRLFMode();
 557                 ASSERT(nCrlfStyle >= 0 && nCrlfStyle <= 3);
 558         }
 559
 560         BOOL bOpenSuccess = TRUE;
 561         BOOL bSaveSuccess = FALSE;
 562
 563         UniStdioFile file;
 564         file.SetUnicoding(bForceUTF8 ? ucr::UTF8 : m_encoding.m_unicoding);
 565         file.SetBom(bForceUTF8 ? true : m_encoding.m_bom);
 566         file.SetCodepage(bForceUTF8 ? CP_UTF8 : m_encoding.m_codepage);
 567
 568         String sIntermediateFilename; // used when !bTempFile
 569
 570         if (bTempFile)
 571         {
 572                 bOpenSuccess = !!file.OpenCreate(pszFileName);
 573         }
 574         else
 575         {
 576                 sIntermediateFilename = env_GetTempFileName(m_strTempPath.c_str(),
 577                         _T("MRG_"), NULL);
 578                 if (sIntermediateFilename.empty())
 579                         return SAVE_FAILED;  //Nothing to do if even tempfile name fails
 580                 bOpenSuccess = !!file.OpenCreate(sIntermediateFilename.c_str());
 581         }
 582
 583         if (!bOpenSuccess)
 584         {
 585                 UniFile::UniError uniErr = file.GetLastUniError();
 586                 if (uniErr.HasError())
 587                 {
 588                         sError = uniErr.GetError().c_str();
 589                         if (bTempFile)
 590                                 LogErrorString(Fmt(_T("Opening file %s failed: %s"),
 591                                         pszFileName, sError.c_str()));
 592                         else
 593                                 LogErrorString(Fmt(_T("Opening file %s failed: %s"),
 594                                         sIntermediateFilename.c_str(), sError.c_str()));
 595                 }
 596                 return SAVE_FAILED;
 597         }
 598
 599         file.WriteBom();
 600
 601         // line loop : get each real line and write it in the file
 602         CString sLine;
 603         CString sEol = GetStringEol(nCrlfStyle);
 604         const size_t nLineCount = m_aLines.size();
 605         for (int line = 0; line < nLineCount; ++line)
 606         {
 607                 if (GetLineFlags(line) & LF_GHOST)
 608                         continue;
 609
 610                 // get the characters of the line (excluding EOL)
 611                 if (GetLineLength(line) > 0)
 612                 {
 613                         int nLineLength = GetLineLength(line);
 614                         void *pszBuf = sLine.GetBuffer(nLineLength);
 615                         memcpy(pszBuf, GetLineChars(line), nLineLength * sizeof(TCHAR));
 616                         sLine.ReleaseBuffer(nLineLength);
 617                 }
 618                 else
 619                         sLine = _T("");
 620
 621                 if (bTempFile)
 622                         EscapeControlChars(sLine);
 623                 // last real line ?
 624                 int lastRealLine = ApparentLastRealLine();
 625                 if (line == lastRealLine || lastRealLine == -1 )
 626                 {
 627                         // last real line is never EOL terminated
 628                         ASSERT (_tcslen(GetLineEol(line)) == 0);
 629                         // write the line and exit loop
 630                         String tmpLine(sLine);
 631                         file.WriteString(tmpLine);
 632                         break;
 633                 }
 634
 635                 // normal real line : append an EOL
 636                 if (nCrlfStyle == CRLF_STYLE_AUTOMATIC || nCrlfStyle == CRLF_STYLE_MIXED)
 637                 {
 638                         // either the EOL of the line (when preserve original EOL chars is on)
 639                         sLine += GetLineEol(line);
 640                 }
 641                 else
 642                 {
 643                         // or the default EOL for this file
 644                         sLine += sEol;
 645                 }
 646
 647                 // write this line to the file (codeset or unicode conversions are done there)
 648                 String tmpLine(sLine);
 649                 file.WriteString(tmpLine);
 650         }
 651         file.Close();
 652
 653         if (!bTempFile)
 654         {
 655                 // If we are saving user files
 656                 // we need an unpacker/packer, at least a "do nothing" one
 657                 ASSERT(infoUnpacker != NULL);
 658                 // repack the file here, overwrite the temporary file we did save in
 659                 String csTempFileName = sIntermediateFilename;
 660                 infoUnpacker->subcode = m_unpackerSubcode;
 661                 if (!FileTransform_Packing(csTempFileName, *infoUnpacker))
 662                 {
 663                         if (!::DeleteFile(sIntermediateFilename.c_str()))
 664                         {
 665                                 LogErrorString(Fmt(_T("DeleteFile(%s) failed: %s"),
 666                                         sIntermediateFilename.c_str(), GetSysError(GetLastError()).c_str()));
 667                         }
 668                         // returns now, don't overwrite the original file
 669                         return SAVE_PACK_FAILED;
 670                 }
 671                 // the temp filename may have changed during packing
 672                 if (csTempFileName != sIntermediateFilename)
 673                 {
 674                         if (!::DeleteFile(sIntermediateFilename.c_str()))
 675                         {
 676                                 LogErrorString(Fmt(_T("DeleteFile(%s) failed: %s"),
 677                                         sIntermediateFilename.c_str(), GetSysError(GetLastError()).c_str()));
 678                         }
 679                         sIntermediateFilename = csTempFileName;
 680                 }
 681
 682                 // Write tempfile over original file
 683                 if (::CopyFile(sIntermediateFilename.c_str(), pszFileName, FALSE))
 684                 {
 685                         if (!::DeleteFile(sIntermediateFilename.c_str()))
 686                         {
 687                                 LogErrorString(Fmt(_T("DeleteFile(%s) failed: %s"),
 688                                         sIntermediateFilename.c_str(), GetSysError(GetLastError()).c_str()));
 689                         }
 690                         if (bClearModifiedFlag)
 691                         {
 692                                 SetModified(FALSE);
 693                                 m_nSyncPosition = m_nUndoPosition;
 694                         }
 695                         bSaveSuccess = TRUE;
 696
 697                         // remember revision number on save
 698                         m_dwRevisionNumberOnSave = m_dwCurrentRevisionNumber;
 699
 700                         // redraw line revision marks
 701                         UpdateViews (NULL, NULL, UPDATE_FLAGSONLY);
 702                 }
 703                 else
 704                 {
 705                         sError = GetSysError(GetLastError());
 706                         LogErrorString(Fmt(_T("CopyFile(%s, %s) failed: %s"),
 707                                 sIntermediateFilename.c_str(), pszFileName, sError.c_str()));
 708                 }
 709         }
 710         else
 711         {
 712                 if (bClearModifiedFlag)
 713                 {
 714                         SetModified(FALSE);
 715                         m_nSyncPosition = m_nUndoPosition;
 716                 }
 717                 bSaveSuccess = TRUE;
 718         }
 719
 720         if (bSaveSuccess)
 721                 return SAVE_DONE;
 722         else
 723                 return SAVE_FAILED;
 724 }
 725
 726 /// Replace line (removing any eol, and only including one if in strText)
 727 void CDiffTextBuffer::ReplaceFullLines(CDiffTextBuffer& dbuf, CDiffTextBuffer& sbuf, CCrystalTextView * pSource, int nLineBegin, int nLineEnd, int nAction /*=CE_ACTION_UNKNOWN*/)
 728 {
 729         int endl,endc;
 730         CString strText;
 731         if (nLineBegin != nLineEnd || sbuf.GetLineLength(nLineEnd) > 0)
 732                 sbuf.GetTextWithoutEmptys(nLineBegin, 0, nLineEnd, sbuf.GetLineLength(nLineEnd), strText);
 733         strText += sbuf.GetLineEol(nLineEnd);
 734
 735         if (nLineBegin != nLineEnd || dbuf.GetFullLineLength(nLineEnd) > 0)
 736         {
 737                 int nLineEndSource = nLineEnd < dbuf.GetLineCount() ? nLineEnd : dbuf.GetLineCount();
 738                 if (nLineEnd+1 < GetLineCount())
 739                         dbuf.DeleteText(pSource, nLineBegin, 0, nLineEndSource + 1, 0, nAction);
 740                 else
 741                         dbuf.DeleteText(pSource, nLineBegin, 0, nLineEndSource, dbuf.GetLineLength(nLineEndSource), nAction);
 742         }
 743
 744         if (int cchText = strText.GetLength())
 745                 dbuf.InsertText(pSource, nLineBegin, 0, strText, cchText, endl,endc, nAction);
 746
 747 }
 748
 749 bool CDiffTextBuffer::curUndoGroup()
 750 {
 751         return (m_aUndoBuf.size() != 0 && m_aUndoBuf[0].m_dwFlags&UNDO_BEGINGROUP);
 752 }