You've already forked edk2-upstream
mirror of
https://github.com/Dasharo/edk2-upstream.git
synced 2026-03-06 15:03:57 -08:00
7a934d0bef
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>
105 lines
3.2 KiB
C
105 lines
3.2 KiB
C
/** @file
|
|
Library used for sorting and comparison routines.
|
|
|
|
Copyright (c) 2009 - 2014, Intel Corporation. All rights reserved. <BR>
|
|
SPDX-License-Identifier: BSD-2-Clause-Patent
|
|
|
|
**/
|
|
|
|
#pragma once
|
|
|
|
/**
|
|
Prototype for comparison function for any two element types.
|
|
|
|
@param[in] Buffer1 The pointer to first buffer.
|
|
@param[in] Buffer2 The pointer to second buffer.
|
|
|
|
@retval 0 Buffer1 equal to Buffer2.
|
|
@return <0 Buffer1 is less than Buffer2.
|
|
@return >0 Buffer1 is greater than Buffer2.
|
|
**/
|
|
typedef
|
|
INTN
|
|
(EFIAPI *SORT_COMPARE)(
|
|
IN CONST VOID *Buffer1,
|
|
IN CONST VOID *Buffer2
|
|
);
|
|
|
|
/**
|
|
Function to perform a Quick Sort on a buffer of comparable elements.
|
|
|
|
Each element must be equally sized.
|
|
|
|
If BufferToSort is NULL, then ASSERT.
|
|
If CompareFunction is NULL, then ASSERT.
|
|
|
|
If Count is < 2 , then perform no action.
|
|
If Size is < 1 , then perform no action.
|
|
|
|
@param[in, out] BufferToSort On call, a Buffer of (possibly sorted) elements;
|
|
on return, a buffer of sorted elements.
|
|
@param[in] Count The number of elements in the buffer to sort.
|
|
@param[in] ElementSize The size of an element in bytes.
|
|
@param[in] CompareFunction The function to call to perform the comparison
|
|
of any two elements.
|
|
**/
|
|
VOID
|
|
EFIAPI
|
|
PerformQuickSort (
|
|
IN OUT VOID *BufferToSort,
|
|
IN CONST UINTN Count,
|
|
IN CONST UINTN ElementSize,
|
|
IN SORT_COMPARE CompareFunction
|
|
);
|
|
|
|
/**
|
|
Function to compare 2 device paths for use as CompareFunction.
|
|
|
|
@param[in] Buffer1 The pointer to Device Path to compare.
|
|
@param[in] Buffer2 The pointer to second DevicePath to compare.
|
|
|
|
@retval 0 Buffer1 equal to Buffer2.
|
|
@return < 0 Buffer1 is less than Buffer2.
|
|
@return > 0 Buffer1 is greater than Buffer2.
|
|
**/
|
|
INTN
|
|
EFIAPI
|
|
DevicePathCompare (
|
|
IN CONST VOID *Buffer1,
|
|
IN CONST VOID *Buffer2
|
|
);
|
|
|
|
/**
|
|
Function to compare 2 strings without regard to case of the characters.
|
|
|
|
@param[in] Buffer1 The pointer to String to compare (CHAR16**).
|
|
@param[in] Buffer2 The pointer to second String to compare (CHAR16**).
|
|
|
|
@retval 0 Buffer1 equal to Buffer2.
|
|
@return < 0 Buffer1 is less than Buffer2.
|
|
@return > 0 Buffer1 is greater than Buffer2.
|
|
**/
|
|
INTN
|
|
EFIAPI
|
|
StringNoCaseCompare (
|
|
IN CONST VOID *Buffer1,
|
|
IN CONST VOID *Buffer2
|
|
);
|
|
|
|
/**
|
|
Function to compare 2 strings.
|
|
|
|
@param[in] Buffer1 The pointer to String to compare (CHAR16**).
|
|
@param[in] Buffer2 The pointer to second String to compare (CHAR16**).
|
|
|
|
@retval 0 Buffer1 equal to Buffer2.
|
|
@return < 0 Buffer1 is less than Buffer2.
|
|
@return > 0 Buffer1 is greater than Buffer2.
|
|
**/
|
|
INTN
|
|
EFIAPI
|
|
StringCompare (
|
|
IN CONST VOID *Buffer1,
|
|
IN CONST VOID *Buffer2
|
|
);
|