Improve handling of splitting remote name and branch name in Reference Browser
[TortoiseGit.git] / src / TortoiseProc / LogFile.h
blobbff36de85aa0749ee27eecf42dfff982f3a11cd7
1 // TortoiseGit - a Windows shell extension for easy version control
3 // Copyright (C) 2007-2008 - TortoiseSVN
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.
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.
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.
19 #pragma once
20 #include "registry.h"
21 #include "TGitPath.h"
22 #include <list>
24 /**
25 * \ingroup TortoiseProc
26 * CLogFile implements a log file with a limited size.
27 * The log file consists of multiple lines. The amount of lines can
28 * be limited with the registry entry Software\\TortoiseGit\\MaxLinesInLogfile
29 * and defaults to 4000 lines.
31 class CLogFile
33 public:
34 CLogFile(void);
35 ~CLogFile(void);
37 /**
38 * Opens the log file and reads its contents
40 bool Open(const CTGitPath& logfile);
41 /**
42 * Opens the default log file for TortoiseSVN and reads its contents
44 bool Open();
45 /**
46 * Adds one line to the log file. The file is \b not yet written back to disk.
48 bool AddLine(const CString& line);
49 /**
50 * Writes the contents to the disk.
52 bool Close();
54 /**
55 * Inserts a line with the current time and date to the log file.
57 bool AddTimeLine();
58 protected:
59 void AdjustSize();
61 private:
62 CRegStdDWORD m_maxlines;
63 CTGitPath m_logfile;
64 std::list<CString> m_lines;