ShellPkg/Include/Protocol/EfiShellInterface.h

   1 /** @file
   2   EFI Shell Interface protocol from EDK shell (no spec).
   3
   4   Shell Interface - additional information (over image_info) provided
   5   to an application started by the shell.
   6
   7   ConIo - provides a file style interface to the console.  Note that the
   8   ConOut & ConIn interfaces in the system table will work as well, and both
   9   all will be redirected to a file if needed on a command line
  10
  11   The shell interface's and data (including ConIo) are only valid during
  12   the applications Entry Point.  Once the application returns from it's
  13   entry point the data is freed by the invoking shell.
  14
  15   Copyright (c) 2006 - 2009, Intel Corporation
  16   All rights reserved. This program and the accompanying materials
  17   are licensed and made available under the terms and conditions of the BSD License
  18   which accompanies this distribution.  The full text of the license may be found at
  19   http://opensource.org/licenses/bsd-license.php
  20
  21   THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
  22   WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
  23
  24 **/
  25
  26 #if !defined(_SHELLINTERFACE_H_)
  27 #define _SHELLINTERFACE_H_
  28
  29 #define SHELL_INTERFACE_PROTOCOL_GUID \
  30   { \
  31     0x47c7b223, 0xc42a, 0x11d2, {0x8e, 0x57, 0x0, 0xa0, 0xc9, 0x69, 0x72, 0x3b} \
  32   }
  33
  34 ///
  35 /// bit definitions for EFI_SHELL_ARG_INFO
  36 ///
  37 typedef enum {
  38   ARG_NO_ATTRIB         = 0x0,
  39   ARG_IS_QUOTED         = BIT0,
  40   ARG_PARTIALLY_QUOTED  = BIT1,
  41   ARG_FIRST_HALF_QUOTED = BIT2,
  42   ARG_FIRST_CHAR_IS_ESC = BIT3
  43 } EFI_SHELL_ARG_INFO_TYPES;
  44
  45 ///
  46 /// attributes for an argument.
  47 ///
  48 typedef struct _EFI_SHELL_ARG_INFO {
  49   UINT32  Attributes;
  50 } EFI_SHELL_ARG_INFO;
  51
  52 ///
  53 /// This protocol provides access to additional information about a shell app.
  54 ///
  55 typedef struct {
  56   ///
  57   /// Handle back to original image handle & image info
  58   ///
  59   EFI_HANDLE                ImageHandle;
  60   EFI_LOADED_IMAGE_PROTOCOL *Info;
  61
  62   ///
  63   /// Parsed arg list converted more C like format
  64   ///
  65   CHAR16                    **Argv;
  66   UINTN                     Argc;
  67
  68   ///
  69   /// Storage for file redirection args after parsing
  70   ///
  71   CHAR16                    **RedirArgv;
  72   UINTN                     RedirArgc;
  73
  74   ///
  75   /// A file style handle for console io
  76   ///
  77   EFI_FILE_HANDLE           StdIn;
  78   EFI_FILE_HANDLE           StdOut;
  79   EFI_FILE_HANDLE           StdErr;
  80
  81   ///
  82   /// list of attributes for each argument
  83   ///
  84   EFI_SHELL_ARG_INFO        *ArgInfo;
  85
  86   ///
  87   /// whether we are echoing
  88   ///
  89   BOOLEAN                   EchoOn;
  90 } EFI_SHELL_INTERFACE;
  91
  92 extern EFI_GUID gEfiShellInterfaceGuid;
  93
  94 #endif