Add a work around Dummy.c file to avoid autogen error to GCC tool chain family.

[mirror_edk2.git] / EdkCompatibilityPkg / Foundation / Efi / Protocol / HiiFont / HiiFont.h

/*++\r
\r
Copyright (c) 2007, Intel Corporation                                                         \r
All rights reserved. This program and the accompanying materials                          \r
are licensed and made available under the terms and conditions of the BSD License         \r
which accompanies this distribution.  The full text of the license may be found at        \r
http://opensource.org/licenses/bsd-license.php                                            \r
                                                                                          \r
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,                     \r
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.             \r
\r
Module Name:\r
\r
    HiiFont.h\r
    \r
Abstract:\r
\r
    EFI_HII_FONT_PROTOCOL from UEFI 2.1 specification.\r
    \r
    This protocol provides interfaces to retrieve font information.\r
\r
Revision History\r
\r
--*/\r
\r
#ifndef __EFI_HII_FONT_PROTOCOL_H__\r
#define __EFI_HII_FONT_PROTOCOL_H__\r
\r
#include EFI_PROTOCOL_DEFINITION (GraphicsOutput)\r
#include EFI_PROTOCOL_DEFINITION (HiiImage)\r
\r
//\r
// Global ID for the Hii Font Protocol.\r
//\r
\r
#define EFI_HII_FONT_PROTOCOL_GUID \\r
  { \\r
    0xe9ca4775, 0x8657, 0x47fc, 0x97, 0xe7, 0x7e, 0xd6, 0x5a, 0x8, 0x43, 0x24 \\r
  }\r
\r
EFI_FORWARD_DECLARATION (EFI_HII_FONT_PROTOCOL);\r
\r
typedef UINT32  EFI_HII_OUT_FLAGS;\r
typedef UINT32  EFI_FONT_INFO_MASK;\r
typedef VOID*   EFI_FONT_HANDLE;\r
\r
typedef struct _EFI_HII_ROW_INFO {\r
  UINTN StartIndex;\r
  UINTN EndIndex;\r
  UINTN LineHeight;\r
  UINTN LineWidth;\r
  UINTN BaselineOffset;\r
} EFI_HII_ROW_INFO;\r
\r
typedef struct {\r
  UINT32 FontStyle;\r
  UINT16 FontSize; // character cell size in pixels\r
  CHAR16 FontName[1];\r
} EFI_FONT_INFO;\r
\r
typedef struct _EFI_FONT_DISPLAY_INFO {\r
  EFI_GRAPHICS_OUTPUT_BLT_PIXEL ForegroundColor;\r
  EFI_GRAPHICS_OUTPUT_BLT_PIXEL BackgroundColor;\r
  EFI_FONT_INFO_MASK            FontInfoMask;\r
  EFI_FONT_INFO                 FontInfo;  \r
} EFI_FONT_DISPLAY_INFO;\r
\r
#define EFI_HII_OUT_FLAG_CLIP        0x00000001\r
#define EFI_HII_OUT_FLAG_WRAP        0x00000002\r
#define EFI_HII_OUT_FLAG_CLEAN_Y     0x00000004\r
#define EFI_HII_OUT_FLAG_CLEAN_X     0x00000008\r
#define EFI_HII_OUT_FLAG_TRANSPARENT 0x00000010\r
#define EFI_HII_IGNORE_IF_NO_GLYPH   0x00000020\r
#define EFI_HII_IGNORE_LINE_BREAK    0x00000040\r
#define EFI_HII_DIRECT_TO_SCREEN     0x00000080\r
\r
#define EFI_FONT_INFO_SYS_FONT       0x00000001\r
#define EFI_FONT_INFO_SYS_SIZE       0x00000002\r
#define EFI_FONT_INFO_SYS_STYLE      0x00000004\r
#define EFI_FONT_INFO_SYS_FORE_COLOR 0x00000010\r
#define EFI_FONT_INFO_SYS_BACK_COLOR 0x00000020\r
#define EFI_FONT_INFO_RESIZE         0x00001000\r
#define EFI_FONT_INFO_RESTYLE        0x00002000\r
#define EFI_FONT_INFO_ANY_FONT       0x00010000\r
#define EFI_FONT_INFO_ANY_SIZE       0x00020000\r
#define EFI_FONT_INFO_ANY_STYLE      0x00040000\r
\r
typedef\r
EFI_STATUS\r
(EFIAPI *EFI_HII_STRING_TO_IMAGE) (\r
  IN  CONST EFI_HII_FONT_PROTOCOL    *This,\r
  IN  EFI_HII_OUT_FLAGS              Flags,\r
  IN  CONST EFI_STRING               String,\r
  IN  CONST EFI_FONT_DISPLAY_INFO    *StringInfo       OPTIONAL,\r
  IN  OUT EFI_IMAGE_OUTPUT           **Blt,\r
  IN  UINTN                          BltX,\r
  IN  UINTN                          BltY,\r
  OUT EFI_HII_ROW_INFO               **RowInfoArray    OPTIONAL,\r
  OUT UINTN                          *RowInfoArraySize OPTIONAL,\r
  OUT UINTN                          *ColumnInfoArray  OPTIONAL\r
  )\r
/*++\r
\r
  Routine Description:\r
    Renders a string to a bitmap or to the display.\r
\r
  Arguments:          \r
    This              - A pointer to the EFI_HII_FONT_PROTOCOL instance.\r
    Flags             - Describes how the string is to be drawn.                 \r
    String            - Points to the null-terminated string to be displayed.\r
    StringInfo        - Points to the string output information, including the color and font. \r
                        If NULL, then the string will be output in the default system font and color.                             \r
    Blt               - If this points to a non-NULL on entry, this points to the image, which is Width pixels  \r
                        wide and Height pixels high. The string will be drawn onto this image and               \r
                        EFI_HII_OUT_FLAG_CLIP is implied. If this points to a NULL on entry, then a             \r
                        buffer will be allocated to hold the generated image and the pointer updated on exit. It\r