src/TortoiseMerge/WorkingFile.h

   1 // TortoiseMerge - a Diff/Patch program
   2
   3 // Copyright (C) 2006-2007 - TortoiseSVN
   4
   5 // This program is free software; you can redistribute it and/or
   6 // modify it under the terms of the GNU General Public License
   7 // as published by the Free Software Foundation; either version 2
   8 // of the License, or (at your option) any later version.
   9
  10 // This program is distributed in the hope that it will be useful,
  11 // but WITHOUT ANY WARRANTY; without even the implied warranty of
  12 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13 // GNU General Public License for more details.
  14
  15 // You should have received a copy of the GNU General Public License
  16 // along with this program; if not, write to the Free Software Foundation,
  17 // 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  18 //
  19 #pragma once
  20
  21 /**
  22  * \ingroup TortoiseMerge
  23  * A class to encapsulate some of the details of working with filenames and descriptive names
  24  * for the various files used in TMerge
  25  */
  26 class CWorkingFile
  27 {
  28 public:
  29         CWorkingFile(void);
  30         ~CWorkingFile(void);
  31
  32 public:
  33         // Is this file in use?
  34         bool InUse() const              { return !m_sFilename.IsEmpty(); }
  35         bool Exists() const;
  36         void SetFileName(const CString& newFilename);
  37         void SetDescriptiveName(const CString& newDescName);
  38         CString GetDescriptiveName();
  39         void CreateEmptyFile();
  40         CString GetWindowName() const;
  41         CString GetFilename() const             { return m_sFilename; }
  42         void SetOutOfUse()                              { m_sFilename.Empty(); m_sDescriptiveName.Empty(); }
  43
  44         // Move the details of the specified file to the current one, and then mark the specified file
  45         // as out of use
  46         void TransferDetailsFrom(CWorkingFile& rightHandFile);
  47
  48 private:
  49         CString m_sFilename;
  50         CString m_sDescriptiveName;
  51
  52 };