Ls.c File Reference

#include "UefiShellLevel2CommandsLib.h"
#include <Guid/FileSystemInfo.h>

Go to the source code of this file.

Functions
EFI_STATUS	PrintSfoVolumeInfoTableEntry (IN CONST EFI_SHELL_FILE_INFO *TheList)
VOID	PrintFileInformation (IN CONST BOOLEAN Sfo, IN CONST EFI_SHELL_FILE_INFO *TheNode, IN UINT64 *Files, IN UINT64 *Size, IN UINT64 *Dirs)
VOID	PrintNonSfoHeader (IN CONST CHAR16 *Path)
VOID	PrintNonSfoFooter (IN UINT64 Files, IN UINT64 Size, IN UINT64 Dirs)
VOID	FileTimeToLocalTime (IN EFI_TIME *Time, IN INT16 LocalTimeZone)
SHELL_STATUS	PrintLsOutput (IN CONST BOOLEAN Rec, IN CONST UINT64 Attribs, IN CONST BOOLEAN Sfo, IN CONST CHAR16 *RootPath, IN CONST CHAR16 *SearchString, IN BOOLEAN *Found, IN CONST UINTN Count, IN CONST INT16 TimeZone, IN CONST BOOLEAN ListUnfiltered)
SHELL_STATUS EFIAPI	ShellCommandRunLs (IN EFI_HANDLE ImageHandle, IN EFI_SYSTEM_TABLE *SystemTable)

Variables
UINTN	mDayOfMonth [] = { 31, 28, 31, 30, 31, 30, 31, 30, 31, 30, 31, 30 }
STATIC CONST SHELL_PARAM_ITEM	LsParamList []

Detailed Description

Main file for ls shell level 2 function.

(C) Copyright 2013-2015 Hewlett-Packard Development Company, L.P.
Copyright (c) 2009 - 2018, Intel Corporation. All rights reserved.
SPDX-License-Identifier: BSD-2-Clause-Patent

Definition in file Ls.c.

Function Documentation

FileTimeToLocalTime()

VOID FileTimeToLocalTime	(	IN EFI_TIME *	Time,
		IN INT16	LocalTimeZone
	)

Change the file time to local time based on the timezone.

Parameters

[in]	Time	The file time.
[in]	LocalTimeZone	Local time zone.

Definition at line 339 of file Ls.c.

PrintFileInformation()

VOID PrintFileInformation	(	IN CONST BOOLEAN	Sfo,
		IN CONST EFI_SHELL_FILE_INFO *	TheNode,
		IN UINT64 *	Files,
		IN UINT64 *	Size,
		IN UINT64 *	Dirs
	)

print out the info on a single file.

Parameters

[in]	Sfo	TRUE if in SFO, false otherwise.
[in]	TheNode	the EFI_SHELL_FILE_INFO node to print out information on.
[in]	Files	incremented if a file is printed.
[in]	Size	incremented by file size.
[in]	Dirs	incremented if a directory is printed.

Definition at line 164 of file Ls.c.

PrintLsOutput()

SHELL_STATUS PrintLsOutput	(	IN CONST BOOLEAN	Rec,
		IN CONST UINT64	Attribs,
		IN CONST BOOLEAN	Sfo,
		IN CONST CHAR16 *	RootPath,
		IN CONST CHAR16 *	SearchString,
		IN BOOLEAN *	Found,
		IN CONST UINTN	Count,
		IN CONST INT16	TimeZone,
		IN CONST BOOLEAN	ListUnfiltered
	)

print out the list of files and directories from the LS command

Parameters

[in]	Rec	TRUE to automatically recurse into each found directory FALSE to only list the specified directory.
[in]	Attribs	List of required Attribute for display. If 0 then all non-system and non-hidden files will be printed.
[in]	Sfo	TRUE to use Standard Format Output, FALSE otherwise
[in]	RootPath	String with starting path to search in.
[in]	SearchString	String with search string.
[in]	Found	Set to TRUE, if anyone were found.
[in]	Count	The count of bits enabled in Attribs.
[in]	TimeZone	The current time zone offset.
[in]	ListUnfiltered	TRUE to request listing the directory contents unfiltered.

Return values

SHELL_SUCCESS

the printing was successful.

Definition at line 445 of file Ls.c.

PrintNonSfoFooter()

VOID PrintNonSfoFooter	(	IN UINT64	Files,
		IN UINT64	Size,
		IN UINT64	Dirs
	)

print out the footer when not using standard format output.

Parameters

[in]	Files	The number of files.
[in]	Size	The size of files in bytes.
[in]	Dirs	The number of directories.

Definition at line 311 of file Ls.c.

PrintNonSfoHeader()

VOID PrintNonSfoHeader

(

IN CONST CHAR16 *

Path

)

print out the header when not using standard format output.

Parameters

[in]

Path

String with starting path.

Definition at line 275 of file Ls.c.

PrintSfoVolumeInfoTableEntry()

EFI_STATUS PrintSfoVolumeInfoTableEntry

(

IN CONST EFI_SHELL_FILE_INFO *

TheList

)

print out the standard format output volume entry.

Parameters

[in]

TheList

a list of files from the volume.

Definition at line 21 of file Ls.c.

ShellCommandRunLs()

SHELL_STATUS EFIAPI ShellCommandRunLs	(	IN EFI_HANDLE	ImageHandle,
		IN EFI_SYSTEM_TABLE *	SystemTable
	)

Function for 'ls' command.

Parameters

[in]	ImageHandle	Handle to the Image (NULL if Internal).
[in]	SystemTable	Pointer to the System Table (NULL if Internal).

Definition at line 722 of file Ls.c.

Variable Documentation

LsParamList

STATIC CONST SHELL_PARAM_ITEM LsParamList[]

Initial value:

= {
  { L"-r",   TypeFlag  },
  { L"-a",   TypeStart },
  { L"-sfo", TypeFlag  },
  { NULL,    TypeMax   }
}

Definition at line 707 of file Ls.c.

mDayOfMonth

UINTN mDayOfMonth[] = { 31, 28, 31, 30, 31, 30, 31, 30, 31, 30, 31, 30 }

Definition at line 13 of file Ls.c.