2010-11-16 22:36:37 +00:00
|
|
|
/** @file
|
|
|
|
|
Header file for compression routine.
|
|
|
|
|
|
2011-03-25 21:22:20 +00:00
|
|
|
Copyright (c) 2005 - 2011, Intel Corporation. All rights reserved.<BR>
|
2019-04-03 16:07:06 -07:00
|
|
|
SPDX-License-Identifier: BSD-2-Clause-Patent
|
2010-11-16 22:36:37 +00:00
|
|
|
|
|
|
|
|
**/
|
|
|
|
|
|
ShellPkg: Replace include guards with #pragma once
Replace traditional `#ifndef`/`#define`/`#endif` include guards with
`#pragma` once.
`#pragma once` is a widely supported preprocessor directive that
prevents header files from being included multiple times. It is
supported by all toolchains used to build edk2: GCC, Clang/LLVM, and
MSVC.
Compared to macro-based include guards, `#pragma once`:
- Eliminates the risk of macro name collisions or copy/paste errors
where two headers inadvertently use the same guard macro.
- Eliminate inconsistency in the way include guard macros are named
(e.g., some files use `__FILE_H__`, others use `FILE_H_`, etc.).
- Reduces boilerplate (three lines replaced by one).
- Avoids polluting the macro namespace with guard symbols.
- Can improve build times as the preprocessor can skip re-opening the
file entirely, rather than re-reading it to find the matching
`#endif` ("multiple-include optimization").
- Note that some compilers may already optimize traditional include
guards, by recognzining the idiomatic pattern.
This change is made acknowledging that overall portability of the
code will technically be reduced, as `#pragma once` is not part of the
C/C++ standards.
However, this is considered acceptable given:
1. edk2 already defines a subset of supported compilers in
BaseTools/Conf/tools_def.template, all of which have supported
`#pragma once` for over two decades.
2. There have been concerns raised to the project about inconsistent
include guard naming and potential macro collisions.
Approximate compiler support dates:
- MSVC: Supported since Visual C++ 4.2 (1996)
- GCC: Supported since 3.4 (2004)
(http://gnu.ist.utl.pt/software/gcc/gcc-3.4/changes.html)
- Clang (LLVM based): Since initial release in 2007
Signed-off-by: Michael Kubacki <michael.kubacki@microsoft.com>
2026-02-03 14:26:33 -05:00
|
|
|
#pragma once
|
2010-11-16 22:36:37 +00:00
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
The compression routine.
|
|
|
|
|
|
2011-09-02 08:05:34 +00:00
|
|
|
@param[in] SrcBuffer The buffer containing the source data.
|
|
|
|
|
@param[in] SrcSize Number of bytes in SrcBuffer.
|
|
|
|
|
@param[in] DstBuffer The buffer to put the compressed image in.
|
|
|
|
|
@param[in, out] DstSize On input the size (in bytes) of DstBuffer, on
|
|
|
|
|
return the number of bytes placed in DstBuffer.
|
2010-11-16 22:36:37 +00:00
|
|
|
|
2023-11-09 11:27:09 -08:00
|
|
|
@retval EFI_SUCCESS The compression was successful.
|
2010-11-16 22:36:37 +00:00
|
|
|
@retval EFI_BUFFER_TOO_SMALL The buffer was too small. DstSize is required.
|
|
|
|
|
**/
|
|
|
|
|
EFI_STATUS
|
|
|
|
|
Compress (
|
|
|
|
|
IN VOID *SrcBuffer,
|
|
|
|
|
IN UINT64 SrcSize,
|
|
|
|
|
IN VOID *DstBuffer,
|
|
|
|
|
IN OUT UINT64 *DstSize
|
|
|
|
|
);
|