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
|
/*
* Copyright 2013 Mihai Niculescu <q.quark@gmail.com>
*
* This file is part of EqualX Project (https://launchpad.net/equalx/)
*
* EqualX 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 3 of the License, or
* (at your option) any later version.
*
* EqualX 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, see <http://www.gnu.org/licenses/>.
*/
#ifndef EQUALXFILE_H
#define EQUALXFILE_H
#include <QString>
#include "defines.h"
#include "FileInfo.h"
namespace EqualX{
/*
* A EqualX File is any file which contains EqualX metadata
*
* This class is used for generating data/files required for reading/writing files with metadata specific for EqualX
* The main purpose of this class is for I/O operations. The description of EqualX metadata is in class EqualX::FileInfo
*/
class File
{
public:
enum OpenMode{
OPEN_READ=0x0,
OPEN_UPDATE=0x1,// READ-WRITE
OPEN_SMART=0x2, // use smart file handler
OPEN_SCAN=0x4 // scan for metadata
};
Q_DECLARE_FLAGS(OpenModes, OpenMode)
File();
File(const EqualX::FileInfo& fileinfo);
~File();
void open(const QString& filename, EqualX::File::OpenModes mode=EqualX::File::OPEN_UPDATE);
void close();
bool read(); // read metadata from the current file and set FileInfo and Metadata
bool write();// write Metadata into the current file
EqualX::FileInfo info() const;
void setInfo(const EqualX::FileInfo& fileinfo);
// write methods for the current FileInfo
// the files are saved in the current working dir and named according to defines.h
void writeLatexFile(bool withBackgroundColor=false); // create a latex file
void writeLatexFileCropped(float llx, float lly, float urx, float ury); // boundingbox: lowerleft x, lowerleft y, upperright x, upperright y
void writeMetadataFile(); // a metadata file to be embedded into files
static bool fetchInfo(const QString& filename, EqualX::FileInfo* fileInfo);
static bool fetchInfo(const char* buffer, size_t len, EqualX::FileInfo *info);
protected:
void __init();
private:
QString mFileName;
EqualX::FileInfo mFileInfo;
struct FileImplementation;
FileImplementation* mClassImpl;
};
typedef QFlags<EqualX::File::OpenMode> EqualXFileOpenMode;
Q_DECLARE_OPERATORS_FOR_FLAGS(File::OpenModes)
}
#endif // EQUALXFILE_H
|
