summaryrefslogtreecommitdiffstats
path: root/src/libs/installer/binarylayout.cpp
diff options
context:
space:
mode:
authorkh1 <karsten.heimrich@digia.com>2014-10-14 17:03:54 +0200
committerKarsten Heimrich <karsten.heimrich@digia.com>2014-10-15 17:10:18 +0200
commit84875396b75f5615afa637f9633d19bbc79e08e0 (patch)
tree012fe931425ae267361a608c0c63e0d05e4ee03e /src/libs/installer/binarylayout.cpp
parentec92e19193eb9d69a3cf18979d6434cf04764902 (diff)
Overhaul the binary format API.
Adjust some naming. Add documentation. Make the Resource class handle files only, this is sufficient to read and map inbuild resources. Keep the QResources inside the manager as well, no need to handle them separate. Remove read, write functions from collection class, the API was just unclear how to use. Still it is far from intuitive in the manager class either. If we open a Resource, we need to close it on our own case they are pointers. Change-Id: Ic8aa32a84a15ac774fe1194ba0dbb5733f7216d6 Reviewed-by: Leena Miettinen <riitta-leena.miettinen@digia.com> Reviewed-by: Kai Koehne <kai.koehne@theqtcompany.com>
Diffstat (limited to 'src/libs/installer/binarylayout.cpp')
-rw-r--r--src/libs/installer/binarylayout.cpp21
1 files changed, 10 insertions, 11 deletions
diff --git a/src/libs/installer/binarylayout.cpp b/src/libs/installer/binarylayout.cpp
index 6437262af..e759e5f17 100644
--- a/src/libs/installer/binarylayout.cpp
+++ b/src/libs/installer/binarylayout.cpp
@@ -41,11 +41,10 @@
/*!
\class QInstaller::BinaryLayout
+ \inmodule QtInstallerFramework
+ \brief The BinaryLayout class describes the binary content appended to a file.
- BinaryLayout handles binary information embedded into executables.
- Qt resources as well as resource collections can be stored.
-
- Explanation of the binary blob at the end of the installer or separate data file:
+ Explanation of the binary content at the end of the installer or the separate data file:
\code
@@ -62,8 +61,8 @@
[Format]
Operation count (qint64)
----------------------------------------------------------
- Component count
- Component data entry [1 ... n]
+ Collection count
+ Collection data entry [1 ... n]
[Format]
Archive count (qint64),
Name entry [1 ... n]
@@ -78,17 +77,17 @@
[Format]
[Format]
----------------------------------------------------------
- Component count (qint64)
- Component index entry [1 ... n]
+ Collection count (qint64)
+ Collection index entry [1 ... n]
[Format]
Name (qint64, QByteArray)
Offset (qint64)
Length (qint64)
[Format]
- Component count (qint64)
+ Collection count (qint64)
----------------------------------------------------------
- Component index block [Offset (qint64)]
- Component index block [Length (qint64)]
+ Collection index block [Offset (qint64)]
+ Collection index block [Length (qint64)]
----------------------------------------------------------
Resource segments [1 ... n]
[Format]