File: diskfile.h

package info (click to toggle)
par2cmdline 1.0.0-2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 5,332 kB
  • sloc: cpp: 14,251; sh: 6,293; makefile: 151
file content (175 lines) | stat: -rw-r--r-- 4,954 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
//  This file is part of par2cmdline (a PAR 2.0 compatible file verification and
//  repair tool). See http://parchive.sourceforge.net for details of PAR 2.0.
//
//  Copyright (c) 2003 Peter Brian Clements
//  Copyright (c) 2019 Michael D. Nahas
//
//  par2cmdline is free software; you can redistribute it and/or modify
//  it under the terms of the GNU General Public License as published by
//  the Free Software Foundation; either version 2 of the License, or
//  (at your option) any later version.
//
//  par2cmdline is distributed in the hope that it will be useful,
//  but WITHOUT ANY WARRANTY; without even the implied warranty of
//  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
//  GNU General Public License for more details.
//
//  You should have received a copy of the GNU General Public License
//  along with this program; if not, write to the Free Software
//  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA

#ifndef __DISKFILE_H__
#define __DISKFILE_H__


// MAX_LENGTH is the maximum read/write size.  It can be OS-dependant.
// The "& ~7" is to make it 8-byte aligned.
// LengthType is the type required for the read/write by the OS.
#ifdef _WIN32
#define MAX_LENGTH (0xffffffffUL & ~7)
#define LengthType DWORD
#else // !_WIN32
#define MAX_LENGTH (0xffffffffUL & ~7)
#define LengthType size_t
#endif


#include <list>
using std::list;
#include <map>
using std::map;
#include <vector>
using std::vector;
#include <memory>

// A disk file can be any type of file that par2cmdline needs
// to read or write data from or to.

class DiskFile
{
public:
  DiskFile(std::ostream &sout, std::ostream &serr);
  ~DiskFile(void);

  // Ensures the specified path's parent directory exists
  bool CreateParentDirectory(string pathname);

  // Create a file and set its length
  bool Create(string filename, u64 filesize);

  // Write some data to the file
  // maxlength should be the default value, except during testing.
  bool Write(u64 offset, const void *buffer, size_t length,
	     LengthType maxlength = MAX_LENGTH);

  // Open the file
  bool Open(void);
  bool Open(const string &filename);
  bool Open(const string &filename, u64 filesize);

  // Check to see if the file is open
#ifdef _WIN32
  bool IsOpen(void) const {return hFile != INVALID_HANDLE_VALUE;}
#else
  bool IsOpen(void) const {return file != 0;}
#endif

  // Read some data from the file
  // maxlength should be the default value, except during testing.
  bool Read(u64 offset, void *buffer, size_t length,
	    LengthType maxlength = MAX_LENGTH);

  // Close the file
  void Close(void);

  // Get the size of the file
  u64 FileSize(void) const {return filesize;}

  // Get the name of the file
  string FileName(void) const {return filename;}

  // Does the file exist
  bool Exists(void) const {return exists;}

  // Rename the file
  bool Rename(void); // Pick a filename automatically
  bool Rename(string filename);

  // Delete the file
  bool Delete(void);

public:
  static string GetCanonicalPathname(string filename);

  static void SplitFilename(string filename, string &path, string &name);
  static void SplitRelativeFilename(string filename, string basepath, string &name);
  static std::string SplitRelativeFilename(const std::string& filename, const std::string& basepath)
  {
    std::string ret;
    SplitRelativeFilename(filename, basepath, ret);
    return ret;
  }

  static bool FileExists(string filename);
  static u64 GetFileSize(string filename);

  // Search the specified path for files which match the specified wildcard
  // and return their names in a list.
  static std::unique_ptr< list<string> > FindFiles(string path, string wildcard, bool recursive);

protected:
  // NOTE: These are pointers so that the operator= works correctly.
  // The references used elsewhere cannot be reassigned.
  // (Operator= is needed when vectors are resized.)
  std::ostream *sout; // stream for output (for commandline, this is cout)
  std::ostream *serr; // stream for errors (for commandline, this is cerr)

  string filename;
  u64    filesize;

  // OS file handle
#ifdef _WIN32
  HANDLE hFile;
#else
  FILE *file;
#endif

  // Current offset within the file
  u64    offset;

  // Does the file exist
  bool   exists;

protected:
#ifdef _WIN32
  static string ErrorMessage(DWORD error);
#endif
};

// This class keeps track of which DiskFile objects exist
// and which file on disk they are associated with.
// It is used to avoid a file being processed twice.
class DiskFileMap
{
public:
  DiskFileMap(void);
  ~DiskFileMap(void);

  bool Insert(DiskFile *diskfile);
  void Remove(DiskFile *diskfile);
  DiskFile* Find(string filename) const;

protected:
  map<string, DiskFile*>    diskfilemap;             // Map from filename to DiskFile
};

class FileSizeCache
{
public:
  FileSizeCache();
  u64 get(const string &filename);
protected:
  map<string, u64> cache;
};

#endif // __DISKFILE_H__