mirror of
https://github.com/tianocore/edk2
synced 2026-08-27 00:23:19 -04:00
58de02af29
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>
81 lines
2.1 KiB
C
81 lines
2.1 KiB
C
/** @file
|
|
Header file for HttpLib.
|
|
|
|
Copyright (c) 2016 - 2017, Intel Corporation. All rights reserved.<BR>
|
|
(C) Copyright 2016 Hewlett Packard Enterprise Development LP<BR>
|
|
|
|
SPDX-License-Identifier: BSD-2-Clause-Patent
|
|
|
|
**/
|
|
|
|
#pragma once
|
|
|
|
#include <Uefi.h>
|
|
#include <Library/NetLib.h>
|
|
#include <Library/HttpLib.h>
|
|
#include <Library/BaseLib.h>
|
|
#include <Library/DebugLib.h>
|
|
#include <Library/MemoryAllocationLib.h>
|
|
#include <Library/UefiBootServicesTableLib.h>
|
|
#include <IndustryStandard/Http11.h>
|
|
#include <Protocol/HttpUtilities.h>
|
|
|
|
#define BIT(x) (1 << x)
|
|
|
|
#define HTTP_VERSION_CRLF_STR " HTTP/1.1\r\n"
|
|
#define EMPTY_SPACE " "
|
|
|
|
#define NET_IS_HEX_CHAR(Ch) \
|
|
((('0' <= (Ch)) && ((Ch) <= '9')) || \
|
|
(('A' <= (Ch)) && ((Ch) <= 'F')) || \
|
|
(('a' <= (Ch)) && ((Ch) <= 'f')))
|
|
|
|
//
|
|
// Field index of the HTTP URL parse result.
|
|
//
|
|
#define HTTP_URI_FIELD_SCHEME 0
|
|
#define HTTP_URI_FIELD_AUTHORITY 1
|
|
#define HTTP_URI_FIELD_PATH 2
|
|
#define HTTP_URI_FIELD_QUERY 3
|
|
#define HTTP_URI_FIELD_FRAGMENT 4
|
|
#define HTTP_URI_FIELD_USERINFO 5
|
|
#define HTTP_URI_FIELD_HOST 6
|
|
#define HTTP_URI_FIELD_PORT 7
|
|
#define HTTP_URI_FIELD_MAX 8
|
|
|
|
#define HTTP_URI_PORT_MAX_NUM 65535
|
|
|
|
//
|
|
// Structure to store the parse result of a HTTP URL.
|
|
//
|
|
typedef struct {
|
|
UINT32 Offset;
|
|
UINT32 Length;
|
|
} HTTP_URL_FILED_DATA;
|
|
|
|
typedef struct {
|
|
UINT16 FieldBitMap;
|
|
HTTP_URL_FILED_DATA FieldData[HTTP_URI_FIELD_MAX];
|
|
} HTTP_URL_PARSER;
|
|
|
|
typedef enum {
|
|
UrlParserUrlStart,
|
|
UrlParserScheme,
|
|
UrlParserSchemeColon, // ":"
|
|
UrlParserSchemeColonSlash, // ":/"
|
|
UrlParserSchemeColonSlashSlash, // "://"
|
|
UrlParserAuthority,
|
|
UrlParserAtInAuthority,
|
|
UrlParserPath,
|
|
UrlParserQueryStart, // "?"
|
|
UrlParserQuery,
|
|
UrlParserFragmentStart, // "#"
|
|
UrlParserFragment,
|
|
UrlParserUserInfo,
|
|
UrlParserHostStart, // "@"
|
|
UrlParserHost,
|
|
UrlParserHostIpv6, // "["(Ipv6 address) "]"
|
|
UrlParserPortStart, // ":"
|
|
UrlParserPort,
|
|
UrlParserStateMax
|
|
} HTTP_URL_PARSE_STATE;
|