TheCloud/panda3d
1
0
Fork 0
mirror of https://github.com/panda3d/panda3d.git synced 2025-09-29 08:15:18 -04:00
Code Issues Packages Projects Releases Wiki Activity

express: Fix up Patchfile docstrings

Browse Source 
[skip ci]
This commit is contained in:
rdb 2021-02-15 14:13:11 +01:00
parent a704d2c228
commit 6374a7f240
1 changed files with 36 additions and 19 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

55
panda/src/express/patchfile.cxx
View File

@ -47,25 +47,39 @@ using std::string;
// USE_MD5_FOR_HASHTABLE_INDEX_VALUES // USE_MD5_FOR_HASHTABLE_INDEX_VALUES
/* /*
* Patch File Format IF THIS CHANGES, UPDATE installerApplyPatch.cxx IN THE * Patch File Format
* INSTALLER [ HEADER ] 4 bytes 0xfeebfaac ("magic number") (older patch * IF THIS CHANGES, UPDATE installerApplyPatch.cxx IN THE INSTALLER
* files have a magic number 0xfeebfaab, indicating they are version number *
* 0.) 2 bytes version number (if magic number == 0xfeebfaac) 4 bytes length * [ HEADER ]
* of starting file (if version >= 1) 16 bytes MD5 of starting file (if * 4 bytes 0xfeebfaac ("magic number")
* version >= 1) 4 bytes length of resulting patched file 16 bytes MD5 of * (older patch files have a magic number 0xfeebfaab,
* resultant patched file Note that MD5 hashes are written in the order * indicating they are version number 0.)
* observed by HashVal::read_stream() and HashVal::write_stream(), which is * 2 bytes version number (if magic number == 0xfeebfaac)
* not the normal linear order. (Each group of four bytes is reversed.) * 4 bytes length of starting file (if version >= 1)
* 16 bytes MD5 of starting file (if version >= 1)
* 4 bytes length of resulting patched file
* 16 bytes MD5 of resultant patched file
*
* Note that MD5 hashes are written in the order observed by
* HashVal::read_stream() and HashVal::write_stream(), which is not
* the normal linear order. (Each group of four bytes is reversed.)
*/ */
const int _v0_header_length = 4 + 4 + 16; const int _v0_header_length = 4 + 4 + 16;
const int _v1_header_length = 4 + 2 + 4 + 16 + 4 + 16; const int _v1_header_length = 4 + 2 + 4 + 16 + 4 + 16;
/* /*
* [ ADDCOPY pairs; repeated N times ] 2 bytes AL = ADD length AL bytes * [ ADD/COPY pairs; repeated N times ]
* bytes to add 2 bytes CL = COPY length 4 bytes offset of data to copy from * 2 bytes AL = ADD length
* original file, if CL != 0. If version >= 2, offset is relative to end of * AL bytes bytes to add
* previous copy block; if version < 2, offset is relative to beginning of * 2 bytes CL = COPY length
* file. [ TERMINATOR ] 2 bytes zero-length ADD 2 bytes zero-length COPY * 4 bytes offset of data to copy from original file, if CL != 0.
* If version >= 2, offset is relative to end of previous
* copy block; if version < 2, offset is relative to
* beginning of file.
*
* [ TERMINATOR ]
* 2 bytes zero-length ADD
* 2 bytes zero-length COPY
*/ */
// Defines // Defines
@ -258,11 +272,14 @@ read_header(const Filename &patch_file) {
} }
/** /**
* Perform one buffer's worth of patching Returns EU_ok while patching Returns * Perform one buffer's worth of patching.
* EU_success when done If error happens will return one of: EU_error_abort : * Returns one of the following values:
* Patching has not been initiated EU_error_file_invalid : file is corrupted * @li @c EU_ok : while patching
* EU_error_invalid_checksum : incompatible patch file * @li @c EU_success : when done
* EU_error_write_file_rename : could not rename file * @li @c EU_error_abort : Patching has not been initiated
* @li @c EU_error_file_invalid : file is corrupted
* @li @c EU_error_invalid_checksum : incompatible patch file
* @li @c EU_error_write_file_rename : could not rename file
*/ */
int Patchfile:: int Patchfile::
run() { run() {