src/TortoiseProc/LogFile.h

   1 // TortoiseGit - a Windows shell extension for easy version control
   2
   3 // Copyright (C) 2013 - TortoiseGit
   4 // Copyright (C) 2007-2008 - TortoiseSVN
   5
   6 // This program is free software; you can redistribute it and/or
   7 // modify it under the terms of the GNU General Public License
   8 // as published by the Free Software Foundation; either version 2
   9 // of the License, or (at your option) any later version.
  10
  11 // This program is distributed in the hope that it will be useful,
  12 // but WITHOUT ANY WARRANTY; without even the implied warranty of
  13 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14 // GNU General Public License for more details.
  15
  16 // You should have received a copy of the GNU General Public License
  17 // along with this program; if not, write to the Free Software Foundation,
  18 // 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  19 //
  20 #pragma once
  21 #include "registry.h"
  22 #include "TGitPath.h"
  23 #include <list>
  24
  25 /**
  26  * \ingroup TortoiseProc
  27  * CLogFile implements a log file with a limited size.
  28  * The log file consists of multiple lines. The amount of lines can
  29  * be limited with the registry entry Software\\TortoiseGit\\MaxLinesInLogfile
  30  * and defaults to 4000 lines.
  31  */
  32 class CLogFile
  33 {
  34 public:
  35         CLogFile(const CString& repo);
  36         ~CLogFile(void);
  37
  38         /**
  39          * Opens the log file and reads its contents
  40          */
  41         bool    Open(const CTGitPath& logfile);
  42         /**
  43          * Opens the default log file for TortoiseSVN and reads its contents
  44          */
  45         bool    Open();
  46         /**
  47          * Adds one line to the log file. The file is \b not yet written back to disk.
  48          */
  49         bool    AddLine(const CString& line);
  50         /**
  51          * Writes the contents to the disk.
  52          */
  53         bool    Close();
  54
  55         /**
  56          * Inserts a line with the current time and date to the log file.
  57          */
  58         bool    AddTimeLine();
  59 protected:
  60         void    AdjustSize();
  61
  62 private:
  63         CString                                 m_sRepo;
  64         CRegStdDWORD                            m_maxlines;
  65         CTGitPath                               m_logfile;
  66         std::list<CString>              m_lines;
  67 };