Intravision/reactos
1
0
Fork 0
mirror of https://github.com/reactos/reactos.git synced 2024-06-26 07:51:52 +00:00
Code Issues Packages Projects Releases Wiki Activity
reactos/boot/freeldr/freeldr/include/ui.h

199 lines
10 KiB
C
Raw Normal View History

Initial revision svn path=/trunk/; revision=1904
2001-05-15 03:50:25 +00:00
/*
* FreeLoader
Changes in v1.8 (1/18/2003) (brianp) - Added F8 options menu - Added custom Boot functionality - Moved all OS= settings from [FreeLoader] section to [Operating Systems] section. - Removed MessageLine= setting. MessageBox= now accepts "\n" as an escape character for newlines. - Added descriptions for disk error codes returned by the BIOS. - Device names like "fd0" and "hd0" and "hd1" as well as BIOS drive numbers can now be used as BootDrive= settings. svn path=/trunk/; revision=4038
2003-01-19 01:04:01 +00:00
* Copyright (C) 1998-2003 Brian Palmer <brianp@sginet.com>
Initial revision svn path=/trunk/; revision=1904
2001-05-15 03:50:25 +00:00
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
- Update address of Free Software Foundation. - Update obsolete LGPL v2 to LGPL v2.1. svn path=/trunk/; revision=43790
2009-10-27 10:34:16 +00:00
* You should have received a copy of the GNU General Public License along
* with this program; if not, write to the Free Software Foundation, Inc.,
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
Initial revision svn path=/trunk/; revision=1904
2001-05-15 03:50:25 +00:00
*/
- Move from using include guards to pragma once. - Whilst this is non-standard and potentially makes the code less portable, it's supported by both gcc and msvc and should bringg increased compilation speed due to its optimized behaviour (doesn't need to invoke the preprocessor) - Patch by Amine Khaldi [amine.khaldi@reactos.org] svn path=/trunk/; revision=45685
2010-02-26 11:43:19 +00:00
#pragma once
Initial revision svn path=/trunk/; revision=1904
2001-05-15 03:50:25 +00:00
[FREELDR] Convert TABs to spaces, no code changes. svn path=/trunk/; revision=59078
2013-05-24 12:20:13 +00:00
extern ULONG UiScreenWidth; // Screen Width
extern ULONG UiScreenHeight; // Screen Height
extern UCHAR UiStatusBarFgColor; // Status bar foreground color
extern UCHAR UiStatusBarBgColor; // Status bar background color
extern UCHAR UiBackdropFgColor; // Backdrop foreground color
extern UCHAR UiBackdropBgColor; // Backdrop background color
extern UCHAR UiBackdropFillStyle; // Backdrop fill style
extern UCHAR UiTitleBoxFgColor; // Title box foreground color
extern UCHAR UiTitleBoxBgColor; // Title box background color
extern UCHAR UiMessageBoxFgColor; // Message box foreground color
extern UCHAR UiMessageBoxBgColor; // Message box background color
extern UCHAR UiMenuFgColor; // Menu foreground color
extern UCHAR UiMenuBgColor; // Menu background color
extern UCHAR UiTextColor; // Normal text color
extern UCHAR UiSelectedTextColor; // Selected text color
extern UCHAR UiSelectedTextBgColor; // Selected text background color
extern UCHAR UiEditBoxTextColor; // Edit box text color
extern UCHAR UiEditBoxBgColor; // Edit box text background color
extern CHAR UiTitleBoxTitleText[260]; // Title box's title text
extern BOOLEAN UiUseSpecialEffects; // Tells us if we should use fade effects
extern BOOLEAN UiCenterMenu;
extern BOOLEAN UiMenuBox;
extern CHAR UiTimeText[];
extern BOOLEAN UiDrawTime;
extern const CHAR UiMonthNames[12][15];
Initial revision svn path=/trunk/; revision=1904
2001-05-15 03:50:25 +00:00
Changes in v1.3 (6/5/2002) - Added protected mode exception handling in case FreeLoader crashes - Reworked memory manager to use all of extended memory - Reworked UI code, now supports multiple text-mode resolutions svn path=/trunk/; revision=3010
2002-06-06 05:58:37 +00:00
///////////////////////////////////////////////////////////////////////////////////////
//
// User Interface Functions
//
///////////////////////////////////////////////////////////////////////////////////////
[FREELDR] Convert TABs to spaces, no code changes. svn path=/trunk/; revision=59078
2013-05-24 12:20:13 +00:00
BOOLEAN UiInitialize(BOOLEAN ShowGui); // Initialize User-Interface
VOID UiUnInitialize(PCSTR BootText); // Un-initialize User-Interface
VOID UiDrawBackdrop(VOID); // Fills the entire screen with a backdrop
VOID UiFillArea(ULONG Left, ULONG Top, ULONG Right, ULONG Bottom, CHAR FillChar, UCHAR Attr /* Color Attributes */); // Fills the area specified with FillChar and Attr
VOID UiDrawShadow(ULONG Left, ULONG Top, ULONG Right, ULONG Bottom); // Draws a shadow on the bottom and right sides of the area specified
VOID UiDrawBox(ULONG Left, ULONG Top, ULONG Right, ULONG Bottom, UCHAR VertStyle, UCHAR HorzStyle, BOOLEAN Fill, BOOLEAN Shadow, UCHAR Attr); // Draws a box around the area specified
VOID UiDrawText(ULONG X, ULONG Y, PCSTR Text, UCHAR Attr); // Draws text at coordinates specified
VOID UiDrawText2(ULONG X, ULONG Y, ULONG MaxNumChars, PCSTR Text, UCHAR Attr); // Draws text at coordinates specified
VOID UiDrawCenteredText(ULONG Left, ULONG Top, ULONG Right, ULONG Bottom, PCSTR TextString, UCHAR Attr); // Draws centered text at the coordinates specified and clips the edges
VOID UiDrawStatusText(PCSTR StatusText); // Draws text at the very bottom line on the screen
VOID UiUpdateDateTime(VOID); // Updates the date and time
VOID UiInfoBox(PCSTR MessageText); // Displays a info box on the screen
[FREELDR] Modify UiMessageBox so that it allows to pass a format string and parameters. Make use of it in WinLdrLoadBootDrivers to show the file that couldn't be loaded. svn path=/trunk/; revision=61625
2014-01-14 20:12:07 +00:00
VOID UiMessageBox(PCSTR Format, ...); // Displays a message box on the screen with an ok button
[FREELDR] Convert TABs to spaces, no code changes. svn path=/trunk/; revision=59078
2013-05-24 12:20:13 +00:00
VOID UiMessageBoxCritical(PCSTR MessageText); // Displays a message box on the screen with an ok button using no system resources
VOID UiDrawProgressBarCenter(ULONG Position, ULONG Range, PCHAR ProgressText); // Draws the progress bar showing nPos percent filled
VOID UiDrawProgressBar(ULONG Left, ULONG Top, ULONG Right, ULONG Bottom, ULONG Position, ULONG Range, PCHAR ProgressText); // Draws the progress bar showing nPos percent filled
[FREELDR] Some ARC-spec compatibility refactoring + simplifications & fixes. CORE-9023 - During loading and initialization of the list of operating systems available in freeldr.ini, convert any legacy operating system entry encountered -- they are like those in NTLDR's boot.ini file, i.e.: ArcOsLoadPartition="LoadIdentifier" /List /of /Options into a new operating system INI entry, like those used by default in FreeLoader. This allows us to avoid treating this corner-case later in different parts of the code. Also, the "BootType" value is now determined there, only once. - Convert the OS loaders entry-points to ARC-compatible ones, following the "Advanced RISC Computing Specification, Version 1.2" specification https://www.netbsd.org/docs/Hardware/Machines/ARC/riscspec.pdf - Introduce helpers for retrieving options values from the argument vector in a simple way. - Simplify LoadOperatingSystem(), since now the "BootType" value has been determined once while loading the list of OSes (see above) and is well-defined there. Use the BuildArgvForOsLoader() helper to build the ARC-compatible argument vector from the corresponding INI settings for the selected operating system entry, and use it when calling the corresponding OS loader. - In the OS loaders, since we can now directly read the settings from the argument vector (instead of using INI settings), we can avoid using a bunch of fixed-size string buffers, and avoid potentially failing IniOpenSection() calls as well. - Simplify code in the Linux loader (and the RemoveQuotes() function). - Add UiShowMessageBoxesInArgv() that acts on the "MessageBox=" settings passed through the argument vector (equivalent to UiShowMessageBoxesInSection() ). - Use string-safe functions where needed (copy/concatenation/printf on fixed-size buffers).
2019-08-06 20:30:54 +00:00
[FREELDR] Convert TABs to spaces, no code changes. svn path=/trunk/; revision=59078
2013-05-24 12:20:13 +00:00
VOID UiShowMessageBoxesInSection(PCSTR SectionName); // Displays all the message boxes in a given section
[FREELDR] Some ARC-spec compatibility refactoring + simplifications & fixes. CORE-9023 - During loading and initialization of the list of operating systems available in freeldr.ini, convert any legacy operating system entry encountered -- they are like those in NTLDR's boot.ini file, i.e.: ArcOsLoadPartition="LoadIdentifier" /List /of /Options into a new operating system INI entry, like those used by default in FreeLoader. This allows us to avoid treating this corner-case later in different parts of the code. Also, the "BootType" value is now determined there, only once. - Convert the OS loaders entry-points to ARC-compatible ones, following the "Advanced RISC Computing Specification, Version 1.2" specification https://www.netbsd.org/docs/Hardware/Machines/ARC/riscspec.pdf - Introduce helpers for retrieving options values from the argument vector in a simple way. - Simplify LoadOperatingSystem(), since now the "BootType" value has been determined once while loading the list of OSes (see above) and is well-defined there. Use the BuildArgvForOsLoader() helper to build the ARC-compatible argument vector from the corresponding INI settings for the selected operating system entry, and use it when calling the corresponding OS loader. - In the OS loaders, since we can now directly read the settings from the argument vector (instead of using INI settings), we can avoid using a bunch of fixed-size string buffers, and avoid potentially failing IniOpenSection() calls as well. - Simplify code in the Linux loader (and the RemoveQuotes() function). - Add UiShowMessageBoxesInArgv() that acts on the "MessageBox=" settings passed through the argument vector (equivalent to UiShowMessageBoxesInSection() ). - Use string-safe functions where needed (copy/concatenation/printf on fixed-size buffers).
2019-08-06 20:30:54 +00:00
VOID
UiShowMessageBoxesInArgv(
IN ULONG Argc,
IN PCHAR Argv[]);
[FREELDR] Convert TABs to spaces, no code changes. svn path=/trunk/; revision=59078
2013-05-24 12:20:13 +00:00
VOID UiEscapeString(PCHAR String); // Processes a string and changes all occurrences of "\n" to '\n'
BOOLEAN UiEditBox(PCSTR MessageText, PCHAR EditTextBuffer, ULONG Length);
UCHAR UiTextToColor(PCSTR ColorText); // Converts the text color into it's equivalent color value
UCHAR UiTextToFillStyle(PCSTR FillStyleText); // Converts the text fill into it's equivalent fill value
VOID UiTruncateStringEllipsis(PCHAR StringText, ULONG MaxChars); // Truncates a string to MaxChars by adding an ellipsis on the end '...'
VOID UiFadeInBackdrop(VOID); // Draws the backdrop and fades the screen in
VOID UiFadeOut(VOID); // Fades the screen out
Changes in v1.7.10 (11/24/2002) (brianp) - Added assembler versions of memcmp() memcpy() memset() - Implemented Int386() so that real-mode interrupts can be called from C-code - Removed unnecessary call in DbgPrint() macro (freeldr.sys is ~16k smaller now) - 64-bit lba sector addressing for disk calls - Re-coded biosdisk.S as i386disk.c - Re-coded mem.S as i386mem.c - Re-coded rtlcode.S as i386rtl.c - Cleaned up i386trap.S so that it only saves the registers once. - Re-coded biosvid.S as i386vid.c - Video fade in/out - VESA text modes supported now - Offscreen buffering to remove flicker - Standardized format of boot sector so that BootPartition is stored right before 0xaa55 - Prefixed all file system functions with 'Fs' svn path=/trunk/; revision=3782
2002-11-24 19:10:06 +00:00
Re-organized things a slight bit. Split up stdlib.c and renamed it to rtl. Separated disk functions from file system functions. svn path=/trunk/; revision=2403
2001-11-28 10:26:53 +00:00
///////////////////////////////////////////////////////////////////////////////////////
//
// Menu Functions
//
///////////////////////////////////////////////////////////////////////////////////////
Add a virtual function table for UI, as already done for machine functions. This leads to simplification of initialization phase, remove some corner cases and (now) unneeded variables. This also lead to always have a UI to display messages (even maybe as simple as a printf() ) svn path=/trunk/; revision=29947
2007-10-29 11:00:31 +00:00
[FREELDR] - Menu titles --> Menu headers (see r57842). - In the same way we introduced menu headers, introduce menu footers, therefore we add the possibility, in mini-tui, of showing or hiding the "For troubleshooting and advanced startup options for ReactOS, press F8." message, only useful for the main menu (the one which shows the list of available OSes installed on the system). svn path=/trunk/; revision=58001
2012-12-24 23:03:11 +00:00
typedef struct tagUI_MENU_INFO
{
[FREELDR] Convert TABs to spaces, no code changes. svn path=/trunk/; revision=59078
2013-05-24 12:20:13 +00:00
PCSTR MenuHeader;
PCSTR MenuFooter;
BOOLEAN ShowBootOptions;
PCSTR* MenuItemList;
ULONG MenuItemCount;
LONG MenuTimeRemaining;
ULONG SelectedMenuItem;
ULONG Left;
ULONG Top;
ULONG Right;
ULONG Bottom;
[FREELDR] - Menu titles --> Menu headers (see r57842). - In the same way we introduced menu headers, introduce menu footers, therefore we add the possibility, in mini-tui, of showing or hiding the "For troubleshooting and advanced startup options for ReactOS, press F8." message, only useful for the main menu (the one which shows the list of available OSes installed on the system). svn path=/trunk/; revision=58001
2012-12-24 23:03:11 +00:00
} UI_MENU_INFO, *PUI_MENU_INFO;
Add a virtual function table for UI, as already done for machine functions. This leads to simplification of initialization phase, remove some corner cases and (now) unneeded variables. This also lead to always have a UI to display messages (even maybe as simple as a printf() ) svn path=/trunk/; revision=29947
2007-10-29 11:00:31 +00:00
typedef BOOLEAN (*UiMenuKeyPressFilterCallback)(ULONG KeyPress);
Changes in v1.8 (1/18/2003) (brianp) - Added F8 options menu - Added custom Boot functionality - Moved all OS= settings from [FreeLoader] section to [Operating Systems] section. - Removed MessageLine= setting. MessageBox= now accepts "\n" as an escape character for newlines. - Added descriptions for disk error codes returned by the BIOS. - Device names like "fd0" and "hd0" and "hd1" as well as BIOS drive numbers can now be used as BootDrive= settings. svn path=/trunk/; revision=4038
2003-01-19 01:04:01 +00:00
[FREELDR] Convert TABs to spaces, no code changes. svn path=/trunk/; revision=59078
2013-05-24 12:20:13 +00:00
BOOLEAN UiDisplayMenu(PCSTR MenuHeader, PCSTR MenuFooter, BOOLEAN ShowBootOptions, PCSTR MenuItemList[], ULONG MenuItemCount, ULONG DefaultMenuItem, LONG MenuTimeOut, ULONG* SelectedMenuItem, BOOLEAN CanEscape, UiMenuKeyPressFilterCallback KeyPressFilter);
Changes in v1.3 (6/5/2002) - Added protected mode exception handling in case FreeLoader crashes - Reworked memory manager to use all of extended memory - Reworked UI code, now supports multiple text-mode resolutions svn path=/trunk/; revision=3010
2002-06-06 05:58:37 +00:00
Add a virtual function table for UI, as already done for machine functions. This leads to simplification of initialization phase, remove some corner cases and (now) unneeded variables. This also lead to always have a UI to display messages (even maybe as simple as a printf() ) svn path=/trunk/; revision=29947
2007-10-29 11:00:31 +00:00
///////////////////////////////////////////////////////////////////////////////////////
//
// UI virtual table
//
///////////////////////////////////////////////////////////////////////////////////////
typedef struct tagUIVTBL
{
[FREELDR] Convert TABs to spaces, no code changes. svn path=/trunk/; revision=59078
2013-05-24 12:20:13 +00:00
BOOLEAN (*Initialize)(VOID);
VOID (*UnInitialize)(VOID);
VOID (*DrawBackdrop)(VOID);
VOID (*FillArea)(ULONG Left, ULONG Top, ULONG Right, ULONG Bottom, CHAR FillChar, UCHAR Attr);
VOID (*DrawShadow)(ULONG Left, ULONG Top, ULONG Right, ULONG Bottom);
VOID (*DrawBox)(ULONG Left, ULONG Top, ULONG Right, ULONG Bottom, UCHAR VertStyle, UCHAR HorzStyle, BOOLEAN Fill, BOOLEAN Shadow, UCHAR Attr);
VOID (*DrawText)(ULONG X, ULONG Y, PCSTR Text, UCHAR Attr);
VOID (*DrawText2)(ULONG X, ULONG Y, ULONG MaxNumChars, PCSTR Text, UCHAR Attr);
VOID (*DrawCenteredText)(ULONG Left, ULONG Top, ULONG Right, ULONG Bottom, PCSTR TextString, UCHAR Attr);
VOID (*DrawStatusText)(PCSTR StatusText);
VOID (*UpdateDateTime)(VOID);
VOID (*MessageBox)(PCSTR MessageText);
VOID (*MessageBoxCritical)(PCSTR MessageText);
VOID (*DrawProgressBarCenter)(ULONG Position, ULONG Range, PCHAR ProgressText);
VOID (*DrawProgressBar)(ULONG Left, ULONG Top, ULONG Right, ULONG Bottom, ULONG Position, ULONG Range, PCHAR ProgressText);
BOOLEAN (*EditBox)(PCSTR MessageText, PCHAR EditTextBuffer, ULONG Length);
UCHAR (*TextToColor)(PCSTR ColorText);
UCHAR (*TextToFillStyle)(PCSTR FillStyleText);
VOID (*FadeInBackdrop)(VOID);
VOID (*FadeOut)(VOID);
BOOLEAN (*DisplayMenu)(PCSTR MenuHeader, PCSTR MenuFooter, BOOLEAN ShowBootOptions, PCSTR MenuItemList[], ULONG MenuItemCount, ULONG DefaultMenuItem, LONG MenuTimeOut, ULONG* SelectedMenuItem, BOOLEAN CanEscape, UiMenuKeyPressFilterCallback KeyPressFilter);
VOID (*DrawMenu)(PUI_MENU_INFO MenuInfo);
Add a virtual function table for UI, as already done for machine functions. This leads to simplification of initialization phase, remove some corner cases and (now) unneeded variables. This also lead to always have a UI to display messages (even maybe as simple as a printf() ) svn path=/trunk/; revision=29947
2007-10-29 11:00:31 +00:00
} UIVTBL, *PUIVTBL;
VOID UiInit(const char *CmdLine);
extern UIVTBL UiVtbl;
/*
* Combines the foreground and background colors into a single attribute byte
*/
[FREELDR] Convert TABs to spaces, no code changes. svn path=/trunk/; revision=59078
2013-05-24 12:20:13 +00:00
#define ATTR(cFore, cBack) ((cBack << 4)|cFore)
Add a virtual function table for UI, as already done for machine functions. This leads to simplification of initialization phase, remove some corner cases and (now) unneeded variables. This also lead to always have a UI to display messages (even maybe as simple as a printf() ) svn path=/trunk/; revision=29947
2007-10-29 11:00:31 +00:00
/*
* Fill styles for DrawBackdrop()
*/
[FREELDR] Convert TABs to spaces, no code changes. svn path=/trunk/; revision=59078
2013-05-24 12:20:13 +00:00
#define LIGHT_FILL 0xB0
#define MEDIUM_FILL 0xB1
#define DARK_FILL 0xB2
Re-organized things a slight bit. Split up stdlib.c and renamed it to rtl. Separated disk functions from file system functions. svn path=/trunk/; revision=2403
2001-11-28 10:26:53 +00:00
Add a virtual function table for UI, as already done for machine functions. This leads to simplification of initialization phase, remove some corner cases and (now) unneeded variables. This also lead to always have a UI to display messages (even maybe as simple as a printf() ) svn path=/trunk/; revision=29947
2007-10-29 11:00:31 +00:00
/*
* Screen colors
*/
[FREELDR] Convert TABs to spaces, no code changes. svn path=/trunk/; revision=59078
2013-05-24 12:20:13 +00:00
#define COLOR_BLACK 0
#define COLOR_BLUE 1
#define COLOR_GREEN 2
#define COLOR_CYAN 3
#define COLOR_RED 4
#define COLOR_MAGENTA 5
#define COLOR_BROWN 6
#define COLOR_GRAY 7
#define COLOR_DARKGRAY 8
#define COLOR_LIGHTBLUE 9
#define COLOR_LIGHTGREEN 10
#define COLOR_LIGHTCYAN 11
#define COLOR_LIGHTRED 12
#define COLOR_LIGHTMAGENTA 13
#define COLOR_YELLOW 14
#define COLOR_WHITE 15
Add a virtual function table for UI, as already done for machine functions. This leads to simplification of initialization phase, remove some corner cases and (now) unneeded variables. This also lead to always have a UI to display messages (even maybe as simple as a printf() ) svn path=/trunk/; revision=29947
2007-10-29 11:00:31 +00:00
/* Add COLOR_BLINK to a background to cause blinking */
[FREELDR] Convert TABs to spaces, no code changes. svn path=/trunk/; revision=59078
2013-05-24 12:20:13 +00:00
//#define COLOR_BLINK 8
Add a virtual function table for UI, as already done for machine functions. This leads to simplification of initialization phase, remove some corner cases and (now) unneeded variables. This also lead to always have a UI to display messages (even maybe as simple as a printf() ) svn path=/trunk/; revision=29947
2007-10-29 11:00:31 +00:00
/*
* Defines for IBM box drawing characters
*/
[FREELDR] Convert TABs to spaces, no code changes. svn path=/trunk/; revision=59078
2013-05-24 12:20:13 +00:00
#define HORZ (0xc4) /* Single horizontal line */
#define D_HORZ (0xcd) /* Double horizontal line.*/
Add a virtual function table for UI, as already done for machine functions. This leads to simplification of initialization phase, remove some corner cases and (now) unneeded variables. This also lead to always have a UI to display messages (even maybe as simple as a printf() ) svn path=/trunk/; revision=29947
2007-10-29 11:00:31 +00:00
#define VERT (0xb3) /* Single vertical line */
#define D_VERT (0xba) /* Double vertical line. */
Reference in a new issue Copy permalink