1 \ Copyright (c) 2003 Scott Long <scottl@FreeBSD.org>
2 \ Copyright (c) 2003 Aleksander Fafula <alex@fafula.com>
3 \ Copyright (c) 2006-2015 Devin Teske <dteske@FreeBSD.org>
6 \ Redistribution and use in source and binary forms, with or without
7 \ modification, are permitted provided that the following conditions
9 \ 1. Redistributions of source code must retain the above copyright
10 \ notice, this list of conditions and the following disclaimer.
11 \ 2. Redistributions in binary form must reproduce the above copyright
12 \ notice, this list of conditions and the following disclaimer in the
13 \ documentation and/or other materials provided with the distribution.
15 \ THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
16 \ ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
17 \ IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
18 \ ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
19 \ FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
20 \ DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
21 \ OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
22 \ HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
23 \ LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
24 \ OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
31 include /boot/frames.4th
33 vocabulary menu-infrastructure
34 vocabulary menu-namespace
35 vocabulary menu-command-helpers
37 only forth also menu-infrastructure definitions
39 f_double \ Set frames to double (see frames.4th). Replace with
40 \ f_single if you want single frames.
41 46 constant dot \ ASCII definition of a period (in decimal)
43 5 constant menu_default_x \ default column position of timeout
44 10 constant menu_default_y \ default row position of timeout msg
45 4 constant menu_timeout_default_x \ default column position of timeout
46 23 constant menu_timeout_default_y \ default row position of timeout msg
47 10 constant menu_timeout_default \ default timeout (in seconds)
49 \ Customize the following values with care
51 1 constant menu_start \ Numerical prefix of first menu item
52 dot constant bullet \ Menu bullet (appears after numerical prefix)
53 5 constant menu_x \ Row position of the menu (from the top)
54 10 constant menu_y \ Column position of the menu (from left side)
57 variable menuidx \ Menu item stack for number prefixes
58 variable menurow \ Menu item stack for positioning
59 variable menubllt \ Menu item bullet
62 variable menuX \ Menu X offset (columns)
63 variable menuY \ Menu Y offset (rows)
66 variable menurebootadded
68 \ Parsing of kernels into menu-items
73 \ Menu timer [count-down] variables
74 variable menu_timeout_enabled \ timeout state (internal use only)
75 variable menu_time \ variable for tracking the passage of time
76 variable menu_timeout \ determined configurable delay duration
77 variable menu_timeout_x \ column position of timeout message
78 variable menu_timeout_y \ row position of timeout message
80 \ Containers for parsing kernels into menu-items
81 create kerncapbuf 64 allot
82 create kerndefault 64 allot
83 create kernelsbuf 256 allot
85 only forth also menu-namespace definitions
87 \ Menu-item key association/detection
101 \ Menu initialization status variables
111 \ Boolean option status variables
112 variable toggle_state1
113 variable toggle_state2
114 variable toggle_state3
115 variable toggle_state4
116 variable toggle_state5
117 variable toggle_state6
118 variable toggle_state7
119 variable toggle_state8
121 \ Array option status variables
122 variable cycle_state1
123 variable cycle_state2
124 variable cycle_state3
125 variable cycle_state4
126 variable cycle_state5
127 variable cycle_state6
128 variable cycle_state7
129 variable cycle_state8
131 \ Containers for storing the initial caption text
132 create init_text1 64 allot
133 create init_text2 64 allot
134 create init_text3 64 allot
135 create init_text4 64 allot
136 create init_text5 64 allot
137 create init_text6 64 allot
138 create init_text7 64 allot
139 create init_text8 64 allot
141 only forth definitions
143 : arch-i386? ( -- BOOL ) \ Returns TRUE (-1) on i386, FALSE (0) otherwise.
144 s" arch-i386" environment? dup if
149 : acpipresent? ( -- flag ) \ Returns TRUE if ACPI is present, FALSE otherwise
150 s" hint.acpi.0.rsdp" getenv
158 : acpienabled? ( -- flag ) \ Returns TRUE if ACPI is enabled, FALSE otherwise
159 s" hint.acpi.0.disabled" getenv
170 : +c! ( N C-ADDR/U K -- C-ADDR/U )
171 3 pick 3 pick ( n c-addr/u k -- n c-addr/u k n c-addr )
172 rot + c! ( n c-addr/u k n c-addr -- n c-addr/u )
173 rot drop ( n c-addr/u -- c-addr/u )
176 only forth also menu-namespace definitions
179 : namespace ( C-ADDR/U N -- ) also menu-namespace +c! evaluate previous ;
180 : menukeyN ( N -- ADDR ) s" menukeyN" 7 namespace ;
181 : init_stateN ( N -- ADDR ) s" init_stateN" 10 namespace ;
182 : toggle_stateN ( N -- ADDR ) s" toggle_stateN" 12 namespace ;
183 : cycle_stateN ( N -- ADDR ) s" cycle_stateN" 11 namespace ;
184 : init_textN ( N -- C-ADDR ) s" init_textN" 9 namespace ;
186 \ Environment variables
187 : kernel[x] ( N -- C-ADDR/U ) s" kernel[x]" 7 +c! ;
188 : menu_init[x] ( N -- C-ADDR/U ) s" menu_init[x]" 10 +c! ;
189 : menu_command[x] ( N -- C-ADDR/U ) s" menu_command[x]" 13 +c! ;
190 : menu_caption[x] ( N -- C-ADDR/U ) s" menu_caption[x]" 13 +c! ;
191 : ansi_caption[x] ( N -- C-ADDR/U ) s" ansi_caption[x]" 13 +c! ;
192 : menu_keycode[x] ( N -- C-ADDR/U ) s" menu_keycode[x]" 13 +c! ;
193 : toggled_text[x] ( N -- C-ADDR/U ) s" toggled_text[x]" 13 +c! ;
194 : toggled_ansi[x] ( N -- C-ADDR/U ) s" toggled_ansi[x]" 13 +c! ;
195 : menu_caption[x][y] ( N M -- C-ADDR/U ) s" menu_caption[x][y]" 16 +c! 13 +c! ;
196 : ansi_caption[x][y] ( N M -- C-ADDR/U ) s" ansi_caption[x][y]" 16 +c! 13 +c! ;
198 also menu-infrastructure definitions
200 \ This function prints a menu item at menuX (row) and menuY (column), returns
201 \ the incremental decimal ASCII value associated with the menu item, and
202 \ increments the cursor position to the next row for the creation of the next
203 \ menu item. This function is called by the menu-create function. You need not
206 : printmenuitem ( menu_item_str -- ascii_keycode )
208 loader_color? if [char] ^ escc! then
210 menurow dup @ 1+ swap ! ( increment menurow )
211 menuidx dup @ 1+ swap ! ( increment menuidx )
213 \ Calculate the menuitem row position
216 \ Position the cursor at the menuitem position
217 dup menuX @ swap at-xy
219 \ Print the value of menuidx
220 loader_color? dup ( -- bool bool )
225 \ Move the cursor forward 1 column
226 dup menuX @ 1+ swap at-xy
228 menubllt @ emit \ Print the menu bullet using the emit function
230 \ Move the cursor to the 3rd column from the current position
231 \ to allow for a space between the numerical prefix and the
233 menuX @ 3 + swap at-xy
235 \ Print the menu caption (we expect a string to be on the stack
236 \ prior to invoking this function)
239 \ Here we will add the ASCII decimal of the numerical prefix
240 \ to the stack (decimal ASCII for `1' is 49) as a "return value"
244 \ This function prints the appropriate menuitem basename to the stack if an
245 \ ACPI option is to be presented to the user, otherwise returns -1. Used
246 \ internally by menu-create, you need not (nor should you) call this directly.
248 : acpimenuitem ( -- C-Addr/U | -1 )
266 menuidx dup @ 1+ swap ! ( increment menuidx )
274 : delim? ( C -- BOOL )
275 dup 32 = ( c -- c bool ) \ [sp] space
276 over 9 = or ( c bool -- c bool ) \ [ht] horizontal tab
277 over 10 = or ( c bool -- c bool ) \ [nl] newline
278 over 13 = or ( c bool -- c bool ) \ [cr] carriage return
279 over [char] , = or ( c bool -- c bool ) \ comma
280 swap drop ( c bool -- bool ) \ return boolean
283 \ This function parses $kernels into variables that are used by the menu to
284 \ display which kernel to boot when the [overloaded] `boot' word is interpreted.
285 \ Used internally by menu-create, you need not (nor should you) call this
288 : parse-kernels ( N -- ) \ kernidx
289 kernidx ! ( n -- ) \ store provided `x' value
290 [char] 0 kernmenuidx ! \ initialize `y' value for menu_caption[x][y]
292 \ Attempt to get a list of kernels, fall back to sensible default
293 s" kernels" getenv dup -1 = if
295 s" kernel kernel.old"
298 \ Check to see if the user has altered $kernel by comparing it against
299 \ $kernel[N] where N is kernel_state (the actively displayed kernel).
300 s" kernel_state" evaluate @ 48 + s" kernel[N]" 7 +c! getenv
302 s" kernel" getenv dup -1 = if
305 2swap 2over compare 0= if
306 2drop FALSE ( skip below conditional )
307 else \ User has changed $kernel
308 TRUE ( slurp in new value )
310 else \ We haven't yet parsed $kernels into $kernel[N]
311 drop ( getenv cruft )
312 s" kernel" getenv dup -1 = if
315 TRUE ( slurp in initial value )
316 then ( c-addr/u -- c-addr/u c-addr/u,-1 | 0 )
317 if \ slurp new value into kerndefault
318 kerndefault 1+ 0 2swap strcat swap 1- c!
321 \ Clear out existing parsed-kernels
324 dup kernel[x] unsetenv
325 2dup menu_caption[x][y] unsetenv
326 2dup ansi_caption[x][y] unsetenv
331 \ Step through the string until we find the end
333 0 kernlen ! \ initialize length of value
335 \ Skip leading whitespace and/or comma delimiters
338 over c@ delim? ( c-addr/u -- c-addr/u bool )
340 false ( c-addr/u -- c-addr/u bool )
343 1- swap 1+ swap ( c-addr/u -- c-addr'/u' )
345 ( c-addr/u -- c-addr'/u' )
347 dup 0= if \ end of string while eating whitespace
348 2drop ( c-addr/u -- )
349 kernmenuidx @ [char] 0 <> if \ found at least one
353 \ No entries in $kernels; use $kernel instead
354 s" kernel" getenv dup -1 = if
357 dup kernlen ! \ store entire value length as kernlen
359 \ We're still within $kernels parsing toward the end;
360 \ find delimiter/end to determine kernlen
361 2dup ( c-addr/u -- c-addr/u c-addr/u )
364 drop 0 ( break ) \ found delimiter
366 kernlen @ 1+ kernlen ! \ incrememnt
367 1- swap 1+ swap \ c-addr++ u--
370 2drop ( c-addr/u c-addr'/u' -- c-addr/u )
372 \ If this is the first entry, compare it to $kernel
373 \ If different, then insert $kernel beforehand
374 kernmenuidx @ [char] 0 = if
375 over kernlen @ kerndefault count compare if
376 kernelsbuf 0 kerndefault count strcat
377 s" ," strcat 2swap strcat
378 kerndefault count swap drop kernlen !
382 ( c-addr/u -- c-addr'/u' )
384 \ At this point, we should have something on the stack to store
385 \ as the next kernel menu option; start assembling variables
387 over kernlen @ ( c-addr/u -- c-addr/u c-addr/u2 )
389 \ Assign first to kernel[x]
390 2dup kernmenuidx @ kernel[x] setenv
392 \ Assign second to menu_caption[x][y]
393 kerncapbuf 0 s" [K]ernel: " strcat
395 kernidx @ kernmenuidx @ menu_caption[x][y]
398 \ Assign third to ansi_caption[x][y]
399 kerncapbuf 0 s" @[1mK@[mernel: " [char] @ escc! strcat
400 kernmenuidx @ [char] 0 = if
405 [char] @ escc! strcat
407 s" @[m" [char] @ escc! strcat
408 kernidx @ kernmenuidx @ ansi_caption[x][y]
411 2drop ( c-addr/u c-addr/u2 -- c-addr/u )
413 kernmenuidx @ 1+ dup kernmenuidx ! [char] 8 > if
414 2drop ( c-addr/u -- ) exit
417 kernlen @ - swap kernlen @ + swap ( c-addr/u -- c-addr'/u' )
421 \ This function goes through the kernels that were discovered by the
422 \ parse-kernels function [above], adding " (# of #)" text to the end of each
426 kernidx @ ( -- x ) dup 0= if exit then
427 [char] 0 s" (Y of Z)" ( x -- x y c-addr/u )
428 kernmenuidx @ -rot 7 +c! \ Replace 'Z' with number of kernels parsed
430 2 pick 1+ -rot 2 +c! \ Replace 'Y' with current ASCII num
432 2over menu_caption[x][y] getenv dup -1 <> if
433 2dup + 1- c@ [char] ) = if
434 2drop \ Already tagged
436 kerncapbuf 0 2swap strcat
438 5 pick 5 pick menu_caption[x][y] setenv
441 drop ( getenv cruft )
444 2over ansi_caption[x][y] getenv dup -1 <> if
445 2dup + 1- c@ [char] ) = if
446 2drop \ Already tagged
448 kerncapbuf 0 2swap strcat
450 5 pick 5 pick ansi_caption[x][y] setenv
453 drop ( getenv cruft )
456 rot 1+ dup [char] 8 > if
457 -rot 2drop TRUE ( break )
465 \ This function creates the list of menu items. This function is called by the
466 \ menu-display function. You need not call it directly.
470 \ Print the frame caption at (x,y)
471 s" loader_menu_title" getenv dup -1 = if
472 drop s" Welcome to FreeBSD"
474 TRUE ( use default alignment )
475 s" loader_menu_title_align" getenv dup -1 <> if
476 2dup s" left" compare-insensitive 0= if ( 1 )
477 2drop ( c-addr/u ) drop ( bool )
479 FALSE ( don't use default alignment )
480 else ( 1 ) 2dup s" right" compare-insensitive 0= if ( 2 )
481 2drop ( c-addr/u ) drop ( bool )
482 menuX @ 42 + 4 - over - menuY @ 1-
483 FALSE ( don't use default alignment )
484 else ( 2 ) 2drop ( c-addr/u ) then ( 1 ) then
486 drop ( getenv cruft )
488 if ( use default center alignement? )
489 menuX @ 19 + over 2 / - menuY @ 1-
493 2drop ( empty loader_menu_title )
498 \ If $menu_init is set, evaluate it (allowing for whole menus to be
499 \ constructed dynamically -- as this function could conceivably set
500 \ the remaining environment variables to construct the menu entirely).
502 s" menu_init" getenv dup -1 <> if
508 \ Print our menu options with respective key/variable associations.
509 \ `printmenuitem' ends by adding the decimal ASCII value for the
510 \ numerical prefix to the stack. We store the value left on the stack
511 \ to the key binding variable for later testing against a character
512 \ captured by the `getkey' function.
514 \ Note that any menu item beyond 9 will have a numerical prefix on the
515 \ screen consisting of the first digit (ie. 1 for the tenth menu item)
516 \ and the key required to activate that menu item will be the decimal
517 \ ASCII of 48 plus the menu item (ie. 58 for the tenth item, aka. `:')
518 \ which is misleading and not desirable.
520 \ Thus, we do not allow more than 8 configurable items on the menu
521 \ (with "Reboot" as the optional ninth and highest numbered item).
524 \ Initialize the ACPI option status.
527 s" menu_acpi" getenv -1 <> if
528 c@ dup 48 > over 57 < and if ( '1' <= c1 <= '8' )
530 arch-i386? if acpipresent? if
532 \ Set menu toggle state to active state
533 \ (required by generic toggle_menuitem)
535 acpienabled? menuacpi @ toggle_stateN !
543 \ Initialize kernel captions after parsing $kernels
546 s" menu_kernel" getenv -1 <> if
547 c@ dup 48 > over 57 < and if ( '1' <= c1 <= '8' )
549 dup parse-kernels tag-kernels
551 \ Get the current cycle state (entry to use)
552 s" kernel_state" evaluate @ 48 + ( n -- n y )
554 \ If state is invalid, reset
555 dup kernmenuidx @ 1- > if
556 drop [char] 0 ( n y -- n 48 )
557 0 s" kernel_state" evaluate !
558 over s" init_kernel" evaluate drop
561 \ Set the current non-ANSI caption
562 2dup swap dup ( n y -- n y y n n )
563 s" set menu_caption[x]=$menu_caption[x][y]"
564 17 +c! 34 +c! 37 +c! evaluate
565 ( n y y n n c-addr/u -- n y )
567 \ Set the current ANSI caption
568 2dup swap dup ( n y -- n y y n n )
569 s" set ansi_caption[x]=$ansi_caption[x][y]"
570 17 +c! 34 +c! 37 +c! evaluate
571 ( n y y n n c-addr/u -- n y )
573 \ Initialize cycle state from stored value
575 s" init_cyclestate" evaluate ( n k -- n )
577 \ Set $kernel to $kernel[y]
578 s" activate_kernel" evaluate ( n -- n )
584 \ Initialize the menu_options visual separator.
587 s" menu_options" getenv -1 <> if
588 c@ dup 48 > over 57 < and if ( '1' <= c1 <= '8' )
595 \ Initialize "Reboot" menu state variable (prevents double-entry)
596 false menurebootadded !
599 1- menuidx ! \ Initialize the starting index for the menu
600 0 menurow ! \ Initialize the starting position for the menu
602 49 \ Iterator start (loop range 49 to 56; ASCII '1' to '8')
604 \ If the "Options:" separator, print it.
605 dup menuoptions @ = if
606 \ Optionally add a reboot option to the menu
607 s" menu_reboot" getenv -1 <> if
609 s" Reboot" printmenuitem menureboot !
610 true menurebootadded !
614 menurow @ 2 + menurow !
617 s" menu_optionstext" getenv dup -1 <> if
624 \ If this is the ACPI menu option, act accordingly.
626 dup acpimenuitem ( n -- n n c-addr/u | n n -1 )
628 13 +c! ( n n c-addr/u -- n c-addr/u )
631 swap drop ( n n -1 -- n -1 )
632 over menu_command[x] unsetenv
635 \ make sure we have not already initialized this item
636 dup init_stateN dup @ 0= if
639 \ If this menuitem has an initializer, run it
659 \ test for environment variable
661 printmenuitem ( c-addr/u -- n )
670 1+ dup 56 > \ add 1 to iterator, continue if less than 57
674 \ Optionally add a reboot option to the menu
675 menurebootadded @ true <> if
676 s" menu_reboot" getenv -1 <> if
677 drop \ no need for the value
678 s" Reboot" \ menu caption (required by printmenuitem)
688 \ Takes a single integer on the stack and updates the timeout display. The
689 \ integer must be between 0 and 9 (we will only update a single digit in the
692 : menu-timeout-update ( N -- )
694 \ Enforce minimum/maximum
695 dup 9 > if drop 9 then
696 dup 0 < if drop 0 then
698 s" Autoboot in N seconds. [Space] to pause" ( n -- n c-addr/u )
701 rot 48 + -rot ( n c-addr/u -- n' c-addr/u ) \ convert to ASCII
702 12 +c! ( n' c-addr/u -- c-addr/u ) \ replace 'N' above
704 menu_timeout_x @ menu_timeout_y @ at-xy \ position cursor
705 type ( c-addr/u -- ) \ print message
707 menu_timeout_x @ menu_timeout_y @ at-xy \ position cursor
708 spaces ( n c-addr/u -- n c-addr ) \ erase message
709 2drop ( n c-addr -- )
712 0 25 at-xy ( position cursor back at bottom-left )
715 \ This function blocks program flow (loops forever) until a key is pressed.
716 \ The key that was pressed is added to the top of the stack in the form of its
717 \ decimal ASCII representation. This function is called by the menu-display
718 \ function. You need not call it directly.
720 : getkey ( -- ascii_keycode )
724 menu_timeout_enabled @ 1 = if
726 seconds ( get current time: -- N )
727 dup menu_time @ <> if ( has time elapsed?: N N N -- N )
729 \ At least 1 second has elapsed since last loop
730 \ so we will decrement our "timeout" (really a
731 \ counter, insuring that we do not proceed too
732 \ fast) and update our timeout display.
734 menu_time ! ( update time record: N -- )
735 menu_timeout @ ( "time" remaining: -- N )
736 dup 0> if ( greater than 0?: N N 0 -- N )
737 1- ( decrement counter: N -- N )
739 ( re-assign: N N Addr -- N )
743 dup 0= swap 0< or if ( N <= 0?: N N -- )
745 0 menu_timeout ! ( 0 Addr -- )
746 0 menu_timeout_enabled ! ( 0 Addr -- )
749 \ update the timer display ( N -- )
750 menu_timeout @ menu-timeout-update
753 \ We've reached the end of the timeout
754 \ (user did not cancel by pressing ANY
757 s" menu_timeout_command" getenv dup
766 \ No [detectable] time has elapsed (in seconds)
772 key? if \ Was a key pressed? (see loader(8))
774 \ An actual key was pressed (if the timeout is running,
775 \ kill it regardless of which key was pressed)
776 menu_timeout @ 0<> if
778 0 menu_timeout_enabled !
780 \ clear screen of timeout message
781 0 menu-timeout-update
784 \ get the key that was pressed and exit (if we
785 \ get a non-zero ASCII code)
792 50 ms \ sleep for 50 milliseconds (see loader(8))
797 : menu-erase ( -- ) \ Erases menu and resets positioning variable to position 1.
799 \ Clear the screen area associated with the interactive menu
801 2dup at-xy 38 spaces 1+ 2dup at-xy 38 spaces 1+
802 2dup at-xy 38 spaces 1+ 2dup at-xy 38 spaces 1+
803 2dup at-xy 38 spaces 1+ 2dup at-xy 38 spaces 1+
804 2dup at-xy 38 spaces 1+ 2dup at-xy 38 spaces 1+
805 2dup at-xy 38 spaces 1+ 2dup at-xy 38 spaces 1+
806 2dup at-xy 38 spaces 1+ 2dup at-xy 38 spaces
809 \ Reset the starting index and position for the menu
810 menu_start 1- menuidx !
815 also menu-infrastructure
817 also menu-command-helpers definitions
819 : toggle_menuitem ( N -- N ) \ toggles caption text and internal menuitem state
821 \ ASCII numeral equal to user-selected menu item must be on the stack.
822 \ We do not modify the stack, so the ASCII numeral is left on top.
824 dup init_textN c@ 0= if
825 \ NOTE: no need to check toggle_stateN since the first time we
826 \ are called, we will populate init_textN. Further, we don't
827 \ need to test whether menu_caption[x] (ansi_caption[x] when
828 \ loader_color?=1) is available since we would not have been
829 \ called if the caption was NULL.
831 \ base name of environment variable
832 dup ( n -- n n ) \ key pressed
840 2 pick ( n c-addr/u -- n c-addr/u n )
841 init_textN ( n c-addr/u n -- n c-addr/u c-addr )
843 \ now we have the buffer c-addr on top
844 \ ( followed by c-addr/u of current caption )
846 \ Copy the current caption into our buffer
847 2dup c! -rot \ store strlen at first byte
849 rot 1+ \ bring alt addr to top and increment
850 -rot -rot \ bring buffer addr to top
851 2dup c@ swap c! \ copy current character
852 1+ \ increment buffer addr
853 rot 1- \ bring buffer len to top and decrement
854 dup 0= \ exit loop if buffer len is zero
856 2drop \ buffer len/addr
864 \ Now we are certain to have init_textN populated with the initial
865 \ value of menu_caption[x] (ansi_caption[x] with loader_color enabled).
866 \ We can now use init_textN as the untoggled caption and
867 \ toggled_text[x] (toggled_ansi[x] with loader_color enabled) as the
868 \ toggled caption and store the appropriate value into menu_caption[x]
869 \ (again, ansi_caption[x] with loader_color enabled). Last, we'll
870 \ negate the toggled state so that we reverse the flow on subsequent
873 dup toggle_stateN @ 0= if
874 \ state is OFF, toggle to ON
876 dup ( n -- n n ) \ key pressed
883 \ Assign toggled text to menu caption
884 2 pick ( n c-addr/u -- n c-addr/u n ) \ key pressed
892 \ No toggled text, keep the same caption
893 drop ( n -1 -- n ) \ getenv cruft
896 true \ new value of toggle state var (to be stored later)
898 \ state is ON, toggle to OFF
900 dup init_textN count ( n -- n c-addr/u )
902 \ Assign init_textN text to menu caption
903 2 pick ( n c-addr/u -- n c-addr/u n ) \ key pressed
911 false \ new value of toggle state var (to be stored below)
914 \ now we'll store the new toggle state (on top of stack)
918 : cycle_menuitem ( N -- N ) \ cycles through array of choices for a menuitem
920 \ ASCII numeral equal to user-selected menu item must be on the stack.
921 \ We do not modify the stack, so the ASCII numeral is left on top.
923 dup cycle_stateN dup @ 1+ \ get value and increment
925 \ Before assigning the (incremented) value back to the pointer,
926 \ let's test for the existence of this particular array element.
927 \ If the element exists, we'll store index value and move on.
928 \ Otherwise, we'll loop around to zero and store that.
930 dup 48 + ( n addr k -- n addr k k' )
931 \ duplicate array index and convert to ASCII numeral
933 3 pick swap ( n addr k k' -- n addr k n k' ) \ (n,k') as (x,y)
939 ( n addr k n k' -- n addr k c-addr/u )
941 \ Now test for the existence of our incremented array index in the
942 \ form of $menu_caption[x][y] ($ansi_caption[x][y] with loader_color
943 \ enabled) as set in loader.rc(5), et. al.
946 \ No caption set for this array index. Loop back to zero.
948 drop ( n addr k -1 -- n addr k ) \ getenv cruft
949 drop 0 ( n addr k -- n addr 0 ) \ new value to store later
951 2 pick [char] 0 ( n addr 0 -- n addr 0 n 48 ) \ (n,48) as (x,y)
957 ( n addr 0 n 48 -- n addr 0 c-addr/u )
959 \ Highly unlikely to occur, but to ensure things move
960 \ along smoothly, allocate a temporary NULL string
965 \ At this point, we should have the following on the stack (in order,
966 \ from bottom to top):
968 \ n - Ascii numeral representing the menu choice (inherited)
969 \ addr - address of our internal cycle_stateN variable
970 \ k - zero-based number we intend to store to the above
971 \ c-addr/u - string value we intend to store to menu_caption[x]
972 \ (or ansi_caption[x] with loader_color enabled)
974 \ Let's perform what we need to with the above.
976 \ Assign array value text to menu caption
977 4 pick ( n addr k c-addr/u -- n addr k c-addr/u n )
985 swap ! ( n addr k -- n ) \ update array state variable
988 only forth definitions also menu-infrastructure
990 \ Erase and redraw the menu. Useful if you change a caption and want to
991 \ update the menu to reflect the new value.
999 f_double ( default frame type )
1000 \ Interpret a custom frame type for the menu
1001 TRUE ( draw a box? default yes, but might be altered below )
1002 s" loader_menu_frame" getenv dup -1 = if ( 1 )
1003 drop \ no custom frame type
1004 else ( 1 ) 2dup s" single" compare-insensitive 0= if ( 2 )
1005 f_single ( see frames.4th )
1006 else ( 2 ) 2dup s" double" compare-insensitive 0= if ( 3 )
1007 f_double ( see frames.4th )
1008 else ( 3 ) s" none" compare-insensitive 0= if ( 4 )
1009 drop FALSE \ don't draw a box
1010 ( 4 ) then ( 3 ) then ( 2 ) then ( 1 ) then
1012 42 13 menuX @ 3 - menuY @ 1- box \ Draw frame (w,h,x,y)
1016 \ This function initializes the menu. Call this from your `loader.rc' file
1017 \ before calling any other menu-related functions.
1021 1- menuidx ! \ Initialize the starting index for the menu
1022 0 menurow ! \ Initialize the starting position for the menu
1024 \ Assign configuration values
1025 s" loader_menu_y" getenv dup -1 = if
1026 drop \ no custom row position
1029 \ make sure custom position is a number
1031 menu_default_y \ or use default
1035 s" loader_menu_x" getenv dup -1 = if
1036 drop \ no custom column position
1039 \ make sure custom position is a number
1041 menu_default_x \ or use default
1046 ['] menu-box console-iterate
1047 0 25 at-xy \ Move cursor to the bottom for output
1052 \ Main function. Call this from your `loader.rc' file.
1054 : menu-display ( -- )
1056 0 menu_timeout_enabled ! \ start with automatic timeout disabled
1058 \ check indication that automatic execution after delay is requested
1059 s" menu_timeout_command" getenv -1 <> if ( Addr C -1 -- | Addr )
1060 drop ( just testing existence right now: Addr -- )
1062 \ initialize state variables
1063 seconds menu_time ! ( store the time we started )
1064 1 menu_timeout_enabled ! ( enable automatic timeout )
1066 \ read custom time-duration (if set)
1067 s" autoboot_delay" getenv dup -1 = if
1068 drop \ no custom duration (remove dup'd bunk -1)
1069 menu_timeout_default \ use default setting
1071 2dup ?number 0= if ( if not a number )
1072 \ disable timeout if "NO", else use default
1073 s" NO" compare-insensitive 0= if
1074 0 menu_timeout_enabled !
1075 0 ( assigned to menu_timeout below )
1077 menu_timeout_default
1082 \ boot immediately if less than zero
1091 menu_timeout ! ( store value on stack from above )
1093 menu_timeout_enabled @ 1 = if
1094 \ read custom column position (if set)
1095 s" loader_menu_timeout_x" getenv dup -1 = if
1096 drop \ no custom column position
1097 menu_timeout_default_x \ use default setting
1099 \ make sure custom position is a number
1101 menu_timeout_default_x \ or use default
1104 menu_timeout_x ! ( store value on stack from above )
1106 \ read custom row position (if set)
1107 s" loader_menu_timeout_y" getenv dup -1 = if
1108 drop \ no custom row position
1109 menu_timeout_default_y \ use default setting
1111 \ make sure custom position is a number
1113 menu_timeout_default_y \ or use default
1116 menu_timeout_y ! ( store value on stack from above )
1122 begin \ Loop forever
1124 0 25 at-xy \ Move cursor to the bottom for output
1125 getkey \ Block here, waiting for a key to be pressed
1128 drop exit \ Caught abort (abnormal return)
1131 \ Boot if the user pressed Enter/Ctrl-M (13) or
1132 \ Ctrl-Enter/Ctrl-J (10)
1133 dup over 13 = swap 10 = or if
1134 drop ( no longer needed )
1136 exit ( pedantic; never reached )
1139 dup menureboot @ = if 0 reboot then
1141 \ Evaluate the decimal ASCII value against known menu item
1142 \ key associations and act accordingly
1144 49 \ Iterator start (loop range 49 to 56; ASCII '1' to '8')
1149 \ Adjust for missing ACPI menuitem on non-i386
1150 arch-i386? true <> menuacpi @ 0<> and if
1151 menuacpi @ over 2dup < -rot = or
1153 ( key >= menuacpi && key < 58: N -- N )
1158 \ Test for the environment variable
1161 \ Execute the stored procedure
1164 \ We expect there to be a non-zero
1165 \ value left on the stack after
1166 \ executing the stored procedure.
1167 \ If so, continue to run, else exit.
1171 drop \ loop iterator
1174 swap \ need iterator on top
1178 \ Re-adjust for missing ACPI menuitem
1179 arch-i386? true <> menuacpi @ 0<> and if
1181 menuacpi @ 1+ over 2dup < -rot = or
1188 swap \ need iterator on top
1192 \ Check for menu keycode shortcut(s)
1217 1+ dup 56 > \ increment iterator
1218 \ continue if less than 57
1220 drop \ loop iterator
1223 again \ Non-operational key was pressed; repeat
1226 \ This function unsets all the possible environment variables associated with
1227 \ creating the interactive menu.
1231 49 \ Iterator start (loop range 49 to 56; ASCII '1' to '8')
1233 dup menu_init[x] unsetenv \ menu initializer
1234 dup menu_command[x] unsetenv \ menu command
1235 dup menu_caption[x] unsetenv \ menu caption
1236 dup ansi_caption[x] unsetenv \ ANSI caption
1237 dup menu_keycode[x] unsetenv \ menu keycode
1238 dup toggled_text[x] unsetenv \ toggle_menuitem caption
1239 dup toggled_ansi[x] unsetenv \ toggle_menuitem ANSI caption
1241 48 \ Iterator start (inner range 48 to 57; ASCII '0' to '9')
1243 \ cycle_menuitem caption and ANSI caption
1244 2dup menu_caption[x][y] unsetenv
1245 2dup ansi_caption[x][y] unsetenv
1248 drop \ inner iterator
1250 0 over menukeyN ! \ used by menu-create, menu-display
1251 0 over init_stateN ! \ used by menu-create
1252 0 over toggle_stateN ! \ used by toggle_menuitem
1253 0 over init_textN c! \ used by toggle_menuitem
1254 0 over cycle_stateN ! \ used by cycle_menuitem
1256 1+ dup 56 > \ increment, continue if less than 57
1260 s" menu_timeout_command" unsetenv \ menu timeout command
1261 s" menu_reboot" unsetenv \ Reboot menu option flag
1262 s" menu_acpi" unsetenv \ ACPI menu option flag
1263 s" menu_kernel" unsetenv \ Kernel menu option flag
1264 s" menu_options" unsetenv \ Options separator flag
1265 s" menu_optionstext" unsetenv \ separator display text
1266 s" menu_init" unsetenv \ menu initializer
1273 only forth definitions also menu-infrastructure
1275 \ This function both unsets menu variables and visually erases the menu area
1276 \ in-preparation for another menu.
1287 \ Initialize our menu initialization state variables
1297 \ Initialize our boolean state variables
1307 \ Initialize our array state variables
1317 \ Initialize string containers
1327 only forth definitions