OpenTTD Source  20241108-master-g80f628063a
MD5File Struct Reference

Structure holding filename and MD5 information about a single file. More...

#include <base_media_base.h>

Public Types

enum  ChecksumResult { CR_UNKNOWN , CR_MATCH , CR_MISMATCH , CR_NO_FILE }
 The result of a checksum check. More...
 

Public Member Functions

ChecksumResult CheckMD5 (Subdirectory subdir, size_t max_size) const
 Calculate and check the MD5 hash of the supplied filename. More...
 

Data Fields

std::string filename
 filename
 
MD5Hash hash
 md5 sum of the file
 
std::string missing_warning
 warning when this file is missing
 
ChecksumResult check_result
 cached result of md5 check
 

Detailed Description

Structure holding filename and MD5 information about a single file.

Definition at line 25 of file base_media_base.h.

Member Enumeration Documentation

◆ ChecksumResult

The result of a checksum check.

Enumerator
CR_UNKNOWN 

The file has not been checked yet.

CR_MATCH 

The file did exist and the md5 checksum did match.

CR_MISMATCH 

The file did exist, just the md5 checksum did not match.

CR_NO_FILE 

The file did not exist.

Definition at line 27 of file base_media_base.h.

Member Function Documentation

◆ CheckMD5()

MD5File::ChecksumResult MD5File::CheckMD5 ( Subdirectory  subdir,
size_t  max_size 
) const

Calculate and check the MD5 hash of the supplied filename.

Parameters
subdirThe sub directory to get the files from
max_sizeOnly calculate the hash for this many bytes from the file start.
Returns

Definition at line 436 of file gfxinit.cpp.

References CR_MATCH, CR_MISMATCH, CR_NO_FILE, filename, FioFOpenFile(), and hash.

Referenced by BaseSet< T, Tnum_files, Tsearch_in_tars >::CheckMD5(), and GraphicsSet::CheckMD5().


The documentation for this struct was generated from the following files: