Mercurial > octave
view scripts/miscellaneous/menu.m @ 32047:e3de59065cf1
inputParser.m: Re-architect internal data structures for 60% speed improvement.
Key idea is to replace Parameter and Switch structs with name field containing
a nested struct (def, val fields) with a struct array that has fields "name",
"def", and "val". This makes it possible to eliminate for loops.
* NEWS.9.md: Announce performance improvement.
* inputParser.m: Declare "Parameter" and "Switch" properties as struct arrays.
Add new private property "last_idx" which caches the last Parameter or Switch
lookup.
* inputParser.m (addRequired): Adjust input validation to use numel() now
rather than numfields().
* inputParser.m (addOptional): Adjust input validation to use numel() now
rather than numfields().
* inputParser.m (addParameter): Change code to add new Parameter to a struct
array.
* inputParser.m (addSwitch): Change code to add new Switch to a struct
array.
* inputParser.m (parse): Adjust initialization of internal variables
ParameterNames and SwitchNames to match new data structure.
Use last_idx to simplify call to validate_arg() for Parameters.
* inputParser.m (validate_arg): Move creation of error message
to code path when error has been found---No need to do it for every
function call. Don't capture "exception" variable in try/catch as
it is no longer used.
* inputParser.m (is_argname): Cache "last_idx" if match was found.
* inputParser.m (add_missing): Replace call to setdiff() with in-place
code which can take advantage of implicit knowledge to eliminate calls
to unique and input validation. Replace for loop with cell2struct/struct2cell
combination.
author | Rik <rik@octave.org> |
---|---|
date | Fri, 21 Apr 2023 11:01:40 -0700 |
parents | 597f3ee61a48 |
children | 2e484f9f1f18 |
line wrap: on
line source
######################################################################## ## ## Copyright (C) 1993-2023 The Octave Project Developers ## ## See the file COPYRIGHT.md in the top-level directory of this ## distribution or <https://octave.org/copyright/>. ## ## This file is part of Octave. ## ## Octave 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 3 of the License, or ## (at your option) any later version. ## ## Octave 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. ## ## You should have received a copy of the GNU General Public License ## along with Octave; see the file COPYING. If not, see ## <https://www.gnu.org/licenses/>. ## ######################################################################## ## -*- texinfo -*- ## @deftypefn {} {@var{choice} =} menu (@var{title}, @var{opt1}, @dots{}) ## @deftypefnx {} {@var{choice} =} menu (@var{title}, @{@var{opt1}, @dots{}@}) ## Display a menu with heading @var{title} and options @var{opt1}, @dots{}, ## and wait for user input. ## ## If the GUI is running, the menu is displayed graphically using ## @code{listdlg}. Otherwise, the title and menu options are printed on the ## console. ## ## @var{title} is a string and the options may be input as individual strings ## or as a cell array of strings. ## ## The return value @var{choice} is the number of the option selected by the ## user counting from 1. If the user aborts the dialog or makes an invalid ## selection then 0 is returned. ## ## This function is useful for interactive programs. There is no limit to the ## number of options that may be passed in, but it may be confusing to present ## more than will fit easily on one screen. ## @seealso{input, listdlg} ## @end deftypefn function choice = menu (title, varargin) if (nargin < 2) print_usage (); endif if (! ischar (title)) error ("menu: TITLE must be a string"); elseif (nargin > 2 && ! iscellstr (varargin)) error ("menu: All OPTIONS must be strings"); elseif (! ischar (varargin{1}) && ! iscellstr (varargin{1})) error ("menu: OPTIONS must be string or cell array of strings"); endif if (__event_manager_enabled__ ()) # GUI menu [choice, ok] = listdlg ("Name", "menu", "PromptString", title, "ListString", varargin, "SelectionMode", "Single"); if (! ok) choice = 0; endif else # console menu ## Force pending output to appear before the menu. fflush (stdout); ## Don't send the menu through the pager as that can cause major confusion. page_screen_output (false, "local"); if (! isempty (title)) printf ("%s\n", title); endif ## Handle case where choices are given as a cell array if (iscellstr (varargin{1})) varargin = varargin{1}; endif nopt = numel (varargin); for i = 1:nopt printf (" [%2d] %s\n", i, varargin{i}); endfor printf ("\n"); s = input ("Select a number: ", "s"); choice = sscanf (s, "%d"); if (! isscalar (choice) || choice < 1 || choice > nopt) warning ("menu: input invalid or out of range\n"); choice = 0; endif endif endfunction ## Test input validation %!error <Invalid call> menu () %!error <Invalid call> menu ("title") %!error <TITLE must be a string> menu (1, "opt1") %!error <All OPTIONS must be strings> menu ("title", "opt1", 1) %!error <OPTIONS must be string or cell array of strings> menu ("title", 1)