Files
Mike Crowe 990e3e81e6 Use LF line endings in the repository
Convert the line endings stored for all text files in the repository to
LF. The majority previously used DOS-style CRLF line endings. Add a
.gitattributes file to enforce this and treat certain extensions as
never being text files.

Update PatchCheck.py to insist on LF line endings rather than CRLF.
However, its other checks fail on this commit due to lots of
pre-existing complaints that it only notices because the line endings
have changed.

Silicon/QemuSocPkg/FspBin/Patches/0001-Build-QEMU-FSP-2.0-binaries.patch
needs to be treated as binary since it contains a mixture of line
endings.

This change has implications depending on the client platform you are
using the repository from:

* Windows

The usual configuration for Git on Windows means that text files will
be checked out to the work tree with DOS-style CRLF line endings. If
that's not the case then you can configure Git to do so for the entire
machine with:

 git config --global core.autocrlf true

or for just the repository with:

 git config core.autocrlf true

Line endings will be normalised to LF when they are committed to the
repository. If you commit a text file with only LF line endings then it
will be converted to CRLF line endings in your work tree.

* Linux, MacOS and other Unices

The usual configuration for Git on such platforms is to check files out
of the repository with LF line endings. This is probably the right thing
for you. In the unlikely even that you are using Git on Unix but editing
or compiling on Windows for some reason then you may need to tweak your
configuration to force the use of CRLF line endings as described above.

* General

For more information see
https://docs.github.com/en/get-started/getting-started-with-git/configuring-git-to-handle-line-endings .

Fixes: https://github.com/slimbootloader/slimbootloader/issues/1400
Signed-off-by: Mike Crowe <mac@mcrowe.com>
2021-11-10 12:46:42 -08:00

110 lines
2.0 KiB
C

/** @file
Header file for string function support library
Copyright (c) 2020, Intel Corporation. All rights reserved.<BR>
SPDX-License-Identifier: BSD-2-Clause-Patent
**/
#ifndef _STRING_SUPPORT_LIB_H_
#define _STRING_SUPPORT_LIB_H_
#include <Library/BootloaderCommonLib.h>
/**
Get next line start pointer.
@param[in] Start The pointer for current line.
@param[out] Length The UINT32 pointer to receive the length of current line.
@retval The pointer for next line.
NULL if no more line is available.
**/
CHAR8 *
EFIAPI
GetNextLine (
IN CHAR8 *Start,
OUT UINT32 *Length
);
/**
Trim leading white space for a line.
@param[in] Line The pointer to the line buffer.
@retval The pointer to the trimmed line.
**/
CHAR8 *
EFIAPI
TrimLeft (
IN CHAR8 *Line
);
/**
Get next space for the start of a line.
@param[in] LineStart The pointer to the start of the line buffer.
@param[in] LineEnd The pointer to the end of the line buffer.
@retval The pointer to the trimmed line.
**/
CHAR8 *
EFIAPI
GetNextSpace (
IN CHAR8 *LineStart,
IN CHAR8 *LineEnd
);
/**
Trim trailing white space for a line.
@param[in] Line The pointer to the line buffer.
@retval The pointer to the trimmed line.
**/
CHAR8 *
EFIAPI
TrimRight (
IN CHAR8 *Line
);
/**
Check if a line starts with a known keyword.
@param[in] Line The pointer to the line buffer.
@param[in] Keyword The pointer to the keyword.
@retval Length of the matched keyword.
0 if there is no match.
**/
UINT32
EFIAPI
MatchKeyWord (
IN CHAR8 *Line,
IN CHAR8 *Keyword
);
/**
Check if a line matches varaible assignment syntax.
@param[in] Line The pointer to the line buffer.
@param[in] Variable The pointer to the variable name.
@retval Length of the matched variable name.
0 if there is no match.
**/
UINT32
EFIAPI
MatchAssignment (
IN CHAR8 *Line,
IN CHAR8 *Variable
);
#endif