annotate tools/drcc/rcc.h @ 57:7be693ea7070

drcc, resource compiler, see interview demo
author eldar
date Tue, 19 May 2009 02:49:08 +0000
parents
children a2871e6b8b15
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
57
7be693ea7070 drcc, resource compiler, see interview demo
eldar
parents:
diff changeset
1 /****************************************************************************
7be693ea7070 drcc, resource compiler, see interview demo
eldar
parents:
diff changeset
2 **
7be693ea7070 drcc, resource compiler, see interview demo
eldar
parents:
diff changeset
3 ** Copyright (C) 2009 Nokia Corporation and/or its subsidiary(-ies).
7be693ea7070 drcc, resource compiler, see interview demo
eldar
parents:
diff changeset
4 ** Contact: Qt Software Information (qt-info@nokia.com)
7be693ea7070 drcc, resource compiler, see interview demo
eldar
parents:
diff changeset
5 **
7be693ea7070 drcc, resource compiler, see interview demo
eldar
parents:
diff changeset
6 ** This file is part of the tools applications of the Qt Toolkit.
7be693ea7070 drcc, resource compiler, see interview demo
eldar
parents:
diff changeset
7 **
7be693ea7070 drcc, resource compiler, see interview demo
eldar
parents:
diff changeset
8 ** $QT_BEGIN_LICENSE:LGPL$
7be693ea7070 drcc, resource compiler, see interview demo
eldar
parents:
diff changeset
9 ** Commercial Usage
7be693ea7070 drcc, resource compiler, see interview demo
eldar
parents:
diff changeset
10 ** Licensees holding valid Qt Commercial licenses may use this file in
7be693ea7070 drcc, resource compiler, see interview demo
eldar
parents:
diff changeset
11 ** accordance with the Qt Commercial License Agreement provided with the
7be693ea7070 drcc, resource compiler, see interview demo
eldar
parents:
diff changeset
12 ** Software or, alternatively, in accordance with the terms contained in
7be693ea7070 drcc, resource compiler, see interview demo
eldar
parents:
diff changeset
13 ** a written agreement between you and Nokia.
7be693ea7070 drcc, resource compiler, see interview demo
eldar
parents:
diff changeset
14 **
7be693ea7070 drcc, resource compiler, see interview demo
eldar
parents:
diff changeset
15 ** GNU Lesser General Public License Usage
7be693ea7070 drcc, resource compiler, see interview demo
eldar
parents:
diff changeset
16 ** Alternatively, this file may be used under the terms of the GNU Lesser
7be693ea7070 drcc, resource compiler, see interview demo
eldar
parents:
diff changeset
17 ** General Public License version 2.1 as published by the Free Software
7be693ea7070 drcc, resource compiler, see interview demo
eldar
parents:
diff changeset
18 ** Foundation and appearing in the file LICENSE.LGPL included in the
7be693ea7070 drcc, resource compiler, see interview demo
eldar
parents:
diff changeset
19 ** packaging of this file. Please review the following information to
7be693ea7070 drcc, resource compiler, see interview demo
eldar
parents:
diff changeset
20 ** ensure the GNU Lesser General Public License version 2.1 requirements
7be693ea7070 drcc, resource compiler, see interview demo
eldar
parents:
diff changeset
21 ** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
7be693ea7070 drcc, resource compiler, see interview demo
eldar
parents:
diff changeset
22 **
7be693ea7070 drcc, resource compiler, see interview demo
eldar
parents:
diff changeset
23 ** In addition, as a special exception, Nokia gives you certain
7be693ea7070 drcc, resource compiler, see interview demo
eldar
parents:
diff changeset
24 ** additional rights. These rights are described in the Nokia Qt LGPL
7be693ea7070 drcc, resource compiler, see interview demo
eldar
parents:
diff changeset
25 ** Exception version 1.0, included in the file LGPL_EXCEPTION.txt in this
7be693ea7070 drcc, resource compiler, see interview demo
eldar
parents:
diff changeset
26 ** package.
7be693ea7070 drcc, resource compiler, see interview demo
eldar
parents:
diff changeset
27 **
7be693ea7070 drcc, resource compiler, see interview demo
eldar
parents:
diff changeset
28 ** GNU General Public License Usage
7be693ea7070 drcc, resource compiler, see interview demo
eldar
parents:
diff changeset
29 ** Alternatively, this file may be used under the terms of the GNU
7be693ea7070 drcc, resource compiler, see interview demo
eldar
parents:
diff changeset
30 ** General Public License version 3.0 as published by the Free Software
7be693ea7070 drcc, resource compiler, see interview demo
eldar
parents:
diff changeset
31 ** Foundation and appearing in the file LICENSE.GPL included in the
7be693ea7070 drcc, resource compiler, see interview demo
eldar
parents:
diff changeset
32 ** packaging of this file. Please review the following information to
7be693ea7070 drcc, resource compiler, see interview demo
eldar
parents:
diff changeset
33 ** ensure the GNU General Public License version 3.0 requirements will be
7be693ea7070 drcc, resource compiler, see interview demo
eldar
parents:
diff changeset
34 ** met: http://www.gnu.org/copyleft/gpl.html.
7be693ea7070 drcc, resource compiler, see interview demo
eldar
parents:
diff changeset
35 **
7be693ea7070 drcc, resource compiler, see interview demo
eldar
parents:
diff changeset
36 ** If you are unsure which license is appropriate for your use, please
7be693ea7070 drcc, resource compiler, see interview demo
eldar
parents:
diff changeset
37 ** contact the sales department at qt-sales@nokia.com.
7be693ea7070 drcc, resource compiler, see interview demo
eldar
parents:
diff changeset
38 ** $QT_END_LICENSE$
7be693ea7070 drcc, resource compiler, see interview demo
eldar
parents:
diff changeset
39 **
7be693ea7070 drcc, resource compiler, see interview demo
eldar
parents:
diff changeset
40 ****************************************************************************/
7be693ea7070 drcc, resource compiler, see interview demo
eldar
parents:
diff changeset
41
7be693ea7070 drcc, resource compiler, see interview demo
eldar
parents:
diff changeset
42 #ifndef RCC_H
7be693ea7070 drcc, resource compiler, see interview demo
eldar
parents:
diff changeset
43 #define RCC_H
7be693ea7070 drcc, resource compiler, see interview demo
eldar
parents:
diff changeset
44
7be693ea7070 drcc, resource compiler, see interview demo
eldar
parents:
diff changeset
45 #include <QtCore/QStringList>
7be693ea7070 drcc, resource compiler, see interview demo
eldar
parents:
diff changeset
46 #include <QtCore/QHash>
7be693ea7070 drcc, resource compiler, see interview demo
eldar
parents:
diff changeset
47 #include <QtCore/QString>
7be693ea7070 drcc, resource compiler, see interview demo
eldar
parents:
diff changeset
48
7be693ea7070 drcc, resource compiler, see interview demo
eldar
parents:
diff changeset
49 QT_BEGIN_NAMESPACE
7be693ea7070 drcc, resource compiler, see interview demo
eldar
parents:
diff changeset
50
7be693ea7070 drcc, resource compiler, see interview demo
eldar
parents:
diff changeset
51 class RCCFileInfo;
7be693ea7070 drcc, resource compiler, see interview demo
eldar
parents:
diff changeset
52 class QIODevice;
7be693ea7070 drcc, resource compiler, see interview demo
eldar
parents:
diff changeset
53 class QTextStream;
7be693ea7070 drcc, resource compiler, see interview demo
eldar
parents:
diff changeset
54
7be693ea7070 drcc, resource compiler, see interview demo
eldar
parents:
diff changeset
55
7be693ea7070 drcc, resource compiler, see interview demo
eldar
parents:
diff changeset
56 class RCCResourceLibrary
7be693ea7070 drcc, resource compiler, see interview demo
eldar
parents:
diff changeset
57 {
7be693ea7070 drcc, resource compiler, see interview demo
eldar
parents:
diff changeset
58 RCCResourceLibrary(const RCCResourceLibrary &);
7be693ea7070 drcc, resource compiler, see interview demo
eldar
parents:
diff changeset
59 RCCResourceLibrary &operator=(const RCCResourceLibrary &);
7be693ea7070 drcc, resource compiler, see interview demo
eldar
parents:
diff changeset
60
7be693ea7070 drcc, resource compiler, see interview demo
eldar
parents:
diff changeset
61 public:
7be693ea7070 drcc, resource compiler, see interview demo
eldar
parents:
diff changeset
62 RCCResourceLibrary();
7be693ea7070 drcc, resource compiler, see interview demo
eldar
parents:
diff changeset
63 ~RCCResourceLibrary();
7be693ea7070 drcc, resource compiler, see interview demo
eldar
parents:
diff changeset
64
7be693ea7070 drcc, resource compiler, see interview demo
eldar
parents:
diff changeset
65 bool output(QIODevice &out, QIODevice &errorDevice);
7be693ea7070 drcc, resource compiler, see interview demo
eldar
parents:
diff changeset
66
7be693ea7070 drcc, resource compiler, see interview demo
eldar
parents:
diff changeset
67 bool readFiles(bool ignoreErrors, QIODevice &errorDevice);
7be693ea7070 drcc, resource compiler, see interview demo
eldar
parents:
diff changeset
68
7be693ea7070 drcc, resource compiler, see interview demo
eldar
parents:
diff changeset
69 enum Format { Binary, C_Code };
7be693ea7070 drcc, resource compiler, see interview demo
eldar
parents:
diff changeset
70 void setFormat(Format f) { m_format = f; }
7be693ea7070 drcc, resource compiler, see interview demo
eldar
parents:
diff changeset
71 Format format() const { return m_format; }
7be693ea7070 drcc, resource compiler, see interview demo
eldar
parents:
diff changeset
72
7be693ea7070 drcc, resource compiler, see interview demo
eldar
parents:
diff changeset
73 void setInputFiles(const QStringList &files) { m_fileNames = files; }
7be693ea7070 drcc, resource compiler, see interview demo
eldar
parents:
diff changeset
74 QStringList inputFiles() const { return m_fileNames; }
7be693ea7070 drcc, resource compiler, see interview demo
eldar
parents:
diff changeset
75
7be693ea7070 drcc, resource compiler, see interview demo
eldar
parents:
diff changeset
76 QStringList dataFiles() const;
7be693ea7070 drcc, resource compiler, see interview demo
eldar
parents:
diff changeset
77
7be693ea7070 drcc, resource compiler, see interview demo
eldar
parents:
diff changeset
78 // Return a map of resource identifier (':/newPrefix/images/p1.png') to file.
7be693ea7070 drcc, resource compiler, see interview demo
eldar
parents:
diff changeset
79 typedef QHash<QString, QString> ResourceDataFileMap;
7be693ea7070 drcc, resource compiler, see interview demo
eldar
parents:
diff changeset
80 ResourceDataFileMap resourceDataFileMap() const;
7be693ea7070 drcc, resource compiler, see interview demo
eldar
parents:
diff changeset
81
7be693ea7070 drcc, resource compiler, see interview demo
eldar
parents:
diff changeset
82 void setVerbose(bool b) { m_verbose = b; }
7be693ea7070 drcc, resource compiler, see interview demo
eldar
parents:
diff changeset
83 bool verbose() const { return m_verbose; }
7be693ea7070 drcc, resource compiler, see interview demo
eldar
parents:
diff changeset
84
7be693ea7070 drcc, resource compiler, see interview demo
eldar
parents:
diff changeset
85 void setInitName(const QString &name) { m_initName = name; }
7be693ea7070 drcc, resource compiler, see interview demo
eldar
parents:
diff changeset
86 QString initName() const { return m_initName; }
7be693ea7070 drcc, resource compiler, see interview demo
eldar
parents:
diff changeset
87
7be693ea7070 drcc, resource compiler, see interview demo
eldar
parents:
diff changeset
88 void setCompressLevel(int c) { m_compressLevel = c; }
7be693ea7070 drcc, resource compiler, see interview demo
eldar
parents:
diff changeset
89 int compressLevel() const { return m_compressLevel; }
7be693ea7070 drcc, resource compiler, see interview demo
eldar
parents:
diff changeset
90
7be693ea7070 drcc, resource compiler, see interview demo
eldar
parents:
diff changeset
91 void setCompressThreshold(int t) { m_compressThreshold = t; }
7be693ea7070 drcc, resource compiler, see interview demo
eldar
parents:
diff changeset
92 int compressThreshold() const { return m_compressThreshold; }
7be693ea7070 drcc, resource compiler, see interview demo
eldar
parents:
diff changeset
93
7be693ea7070 drcc, resource compiler, see interview demo
eldar
parents:
diff changeset
94 void setResourceRoot(const QString &root) { m_resourceRoot = root; }
7be693ea7070 drcc, resource compiler, see interview demo
eldar
parents:
diff changeset
95 QString resourceRoot() const { return m_resourceRoot; }
7be693ea7070 drcc, resource compiler, see interview demo
eldar
parents:
diff changeset
96
7be693ea7070 drcc, resource compiler, see interview demo
eldar
parents:
diff changeset
97 void setUseNameSpace(bool v) { m_useNameSpace = v; }
7be693ea7070 drcc, resource compiler, see interview demo
eldar
parents:
diff changeset
98 bool useNameSpace() const { return m_useNameSpace; }
7be693ea7070 drcc, resource compiler, see interview demo
eldar
parents:
diff changeset
99
7be693ea7070 drcc, resource compiler, see interview demo
eldar
parents:
diff changeset
100 QStringList failedResources() const { return m_failedResources; }
7be693ea7070 drcc, resource compiler, see interview demo
eldar
parents:
diff changeset
101
7be693ea7070 drcc, resource compiler, see interview demo
eldar
parents:
diff changeset
102 private:
7be693ea7070 drcc, resource compiler, see interview demo
eldar
parents:
diff changeset
103 struct Strings {
7be693ea7070 drcc, resource compiler, see interview demo
eldar
parents:
diff changeset
104 Strings();
7be693ea7070 drcc, resource compiler, see interview demo
eldar
parents:
diff changeset
105 const QString TAG_RCC;
7be693ea7070 drcc, resource compiler, see interview demo
eldar
parents:
diff changeset
106 const QString TAG_RESOURCE;
7be693ea7070 drcc, resource compiler, see interview demo
eldar
parents:
diff changeset
107 const QString TAG_FILE;
7be693ea7070 drcc, resource compiler, see interview demo
eldar
parents:
diff changeset
108 const QString ATTRIBUTE_LANG;
7be693ea7070 drcc, resource compiler, see interview demo
eldar
parents:
diff changeset
109 const QString ATTRIBUTE_PREFIX;
7be693ea7070 drcc, resource compiler, see interview demo
eldar
parents:
diff changeset
110 const QString ATTRIBUTE_ALIAS;
7be693ea7070 drcc, resource compiler, see interview demo
eldar
parents:
diff changeset
111 const QString ATTRIBUTE_THRESHOLD;
7be693ea7070 drcc, resource compiler, see interview demo
eldar
parents:
diff changeset
112 const QString ATTRIBUTE_COMPRESS;
7be693ea7070 drcc, resource compiler, see interview demo
eldar
parents:
diff changeset
113 };
7be693ea7070 drcc, resource compiler, see interview demo
eldar
parents:
diff changeset
114 friend class RCCFileInfo;
7be693ea7070 drcc, resource compiler, see interview demo
eldar
parents:
diff changeset
115 void reset();
7be693ea7070 drcc, resource compiler, see interview demo
eldar
parents:
diff changeset
116 bool addFile(const QString &alias, const RCCFileInfo &file);
7be693ea7070 drcc, resource compiler, see interview demo
eldar
parents:
diff changeset
117 bool interpretResourceFile(QIODevice *inputDevice, const QString &file,
7be693ea7070 drcc, resource compiler, see interview demo
eldar
parents:
diff changeset
118 QString currentPath = QString(), bool ignoreErrors = false);
7be693ea7070 drcc, resource compiler, see interview demo
eldar
parents:
diff changeset
119 bool writeHeader();
7be693ea7070 drcc, resource compiler, see interview demo
eldar
parents:
diff changeset
120 bool writeDataBlobs();
7be693ea7070 drcc, resource compiler, see interview demo
eldar
parents:
diff changeset
121 bool writeDataNames();
7be693ea7070 drcc, resource compiler, see interview demo
eldar
parents:
diff changeset
122 bool writeDataStructure();
7be693ea7070 drcc, resource compiler, see interview demo
eldar
parents:
diff changeset
123 bool writeInitializer();
7be693ea7070 drcc, resource compiler, see interview demo
eldar
parents:
diff changeset
124 void writeMangleNamespaceFunction(const QByteArray &name);
7be693ea7070 drcc, resource compiler, see interview demo
eldar
parents:
diff changeset
125 void writeAddNamespaceFunction(const QByteArray &name);
7be693ea7070 drcc, resource compiler, see interview demo
eldar
parents:
diff changeset
126 void writeHex(quint8 number);
7be693ea7070 drcc, resource compiler, see interview demo
eldar
parents:
diff changeset
127 void writeNumber2(quint16 number);
7be693ea7070 drcc, resource compiler, see interview demo
eldar
parents:
diff changeset
128 void writeNumber4(quint32 number);
7be693ea7070 drcc, resource compiler, see interview demo
eldar
parents:
diff changeset
129 void writeChar(char c) { m_out.append(c); }
7be693ea7070 drcc, resource compiler, see interview demo
eldar
parents:
diff changeset
130 void writeByteArray(const QByteArray &);
7be693ea7070 drcc, resource compiler, see interview demo
eldar
parents:
diff changeset
131 void write(const char *, int len);
7be693ea7070 drcc, resource compiler, see interview demo
eldar
parents:
diff changeset
132
7be693ea7070 drcc, resource compiler, see interview demo
eldar
parents:
diff changeset
133 const Strings m_strings;
7be693ea7070 drcc, resource compiler, see interview demo
eldar
parents:
diff changeset
134 RCCFileInfo *m_root;
7be693ea7070 drcc, resource compiler, see interview demo
eldar
parents:
diff changeset
135 QStringList m_fileNames;
7be693ea7070 drcc, resource compiler, see interview demo
eldar
parents:
diff changeset
136 QString m_resourceRoot;
7be693ea7070 drcc, resource compiler, see interview demo
eldar
parents:
diff changeset
137 QString m_initName;
7be693ea7070 drcc, resource compiler, see interview demo
eldar
parents:
diff changeset
138 Format m_format;
7be693ea7070 drcc, resource compiler, see interview demo
eldar
parents:
diff changeset
139 bool m_verbose;
7be693ea7070 drcc, resource compiler, see interview demo
eldar
parents:
diff changeset
140 int m_compressLevel;
7be693ea7070 drcc, resource compiler, see interview demo
eldar
parents:
diff changeset
141 int m_compressThreshold;
7be693ea7070 drcc, resource compiler, see interview demo
eldar
parents:
diff changeset
142 int m_treeOffset;
7be693ea7070 drcc, resource compiler, see interview demo
eldar
parents:
diff changeset
143 int m_namesOffset;
7be693ea7070 drcc, resource compiler, see interview demo
eldar
parents:
diff changeset
144 int m_dataOffset;
7be693ea7070 drcc, resource compiler, see interview demo
eldar
parents:
diff changeset
145 bool m_useNameSpace;
7be693ea7070 drcc, resource compiler, see interview demo
eldar
parents:
diff changeset
146 QStringList m_failedResources;
7be693ea7070 drcc, resource compiler, see interview demo
eldar
parents:
diff changeset
147 QIODevice *m_errorDevice;
7be693ea7070 drcc, resource compiler, see interview demo
eldar
parents:
diff changeset
148 QByteArray m_out;
7be693ea7070 drcc, resource compiler, see interview demo
eldar
parents:
diff changeset
149 };
7be693ea7070 drcc, resource compiler, see interview demo
eldar
parents:
diff changeset
150
7be693ea7070 drcc, resource compiler, see interview demo
eldar
parents:
diff changeset
151 QT_END_NAMESPACE
7be693ea7070 drcc, resource compiler, see interview demo
eldar
parents:
diff changeset
152
7be693ea7070 drcc, resource compiler, see interview demo
eldar
parents:
diff changeset
153 #endif // RCC_H