xref: /freebsd/contrib/bsddialog/CHANGELOG (revision db33c6f3ae9d1231087710068ee4ea5398aacca7)
12024-07-01 1.0.4
2
3	Utility internal refactoring (no functional change):
4	* change: rename an internal constant to avoid a future conflict
5	    because FreeBSD is changing headers files for _FORTIFY_SOURCE.
6	    Reported and fixed by Kyle Evans.
7
82024-05-27 1.0.3
9
10	Utility:
11	change: --form and --mixedform do not print field value to output fd if
12	        <fieldlen> is <= 0 (readonly). To note --mixedgauge continues
13	        to print field value if <flag> = 2 (readonly) unless <fieldlen>
14	        is <= 0 (as described previously).
15
16
172024-04-11 Version 1.0.2
18
19	Utility:
20	improvements and changes for --form and --mixedform:
21	    * add: <maxletters> 0 sets <maxletters> like <fieldlen>.
22	    * add: <fieldlen> 0 sets <fieldlen> like <init> width and readonly.
23	    * change: <maxletters> 0 was an error (remains error in lib).
24	    * change: <fieldlen> 0 was an error (remains error in lib)
25	      (<fieldlen> 0 and <init> "" is still an error.).
26
27	Library and implicitly utility:
28	* add: Ctrl-l to redraw dialog.
29	    Request stable@freebsd.org January 2024.
30	* add: -, +, Ctrl-p, Ctrl-n for several dialogs.
31	    +, - request for menus, private feature request.
32	    Ctrl-p, Ctrl-n for menu, request hackers@freebsd.org February 2024.
33	* fix: escaped text ending with an escape symbol.
34	* change: truncate mixedgauge long (over the screen/minibars)
35	    minilabels adding "...". As a result, avoid check-size error.
36	    https://gitlab.com/alfix/bsddialog/-/issues/6.
37	* change: invert UP/DOWN keys to set a rangebox value.
38
39
402023-11-16 Version 1.0.1
41
42	Library Internal Refactoring:
43	* add: arrow macro handlers.
44	* change: Box-drawing characters, from utf8 to wide chars to avoid to
45	    handle "env NCURSES_NO_UTF8_ACS=1".
46	    Request https://bugs.freebsd.org/274472,
47	    Rationale https://reviews.freebsd.org/D42380.
48
492023-08-01 Version 1.0
50
51	Utility:
52	* add: comments to --save-theme output file.
53	* add: blink, halfbright, highlight to --save-theme and --load-theme.
54	* add: theme.menu.[f_]prefixcolor to --save-theme and --load-theme.
55	* add: --datebox-format <d/m/y|m/d/y|y/m/d> to set --datebox UI.
56	* add: --help-print-items (--help-status becomes alias).
57	* add: --text-escape (--colors becomes alias).
58	* add: new escapes \Zd, \Zk, \Zs, \ZD, \ZK, \ZS, for --text-escape.
59	* add: env NO_COLOR, to set blackwhite theme.
60	* add: $HOME/.bsddialog.conf startup theme file.
61	* add: env BSDDIALOG_THEMEFILE startup theme file.
62	* add: --left1-button <label>.
63	* add: --left2-button <label>.
64	* add: --left3-button <label>.
65	* add: --right1-button <label>.
66	* add: --right2-button <label>.
67	* add: --right3-button <label>.
68	* add: dynamic exit codes.
69	    - add: --error-exit-code.
70	    - add: --ok-exit-code.
71	    - add: --cancel-exit-code.
72	    - add: --help-exit-code.
73	    - add: --extra-exit-code.
74	    - add: --timeout-exit-code.
75	    - add: --esc-exit-code.
76	    - add: --left1-exit-code.
77	    - add: --left2-exit-code.
78	    - add: --left3-exit-code.
79	    - add: --right1-exit-code.
80	    - add: --right2-exit-code.
81	    - add: --right3-exit-code.
82	    - add: env BSDDIALOG_ERROR.
83	    - add: env BSDDIALOG_OK.
84	    - add: env BSDDIALOG_CANCEL.
85	    - add: env BSDDIALOG_HELP.
86	    - add: env BSDDIALOG_EXTRA.
87	    - add: env BSDDIALOG_TIMEOUT.
88	    - add: env BSDDIALOG_ESC.
89	    - add: env BSDDIALOG_LEFT1.
90	    - add: env BSDDIALOG_LEFT2.
91	    - add: env BSDDIALOG_LEFT3.
92	    - add: env BSDDIALOG_RIGHT1.
93	    - add: env BSDDIALOG_RIGHT2.
94	    - add: env BSDDIALOG_RIGHT3.
95	* add: undocumented envs for bsdconfig(8) compatibility.
96	    - env BSDDIALOG_COMPATRC for use_shadow setting.
97	    - env BSDDIALOG_ITEM_HELP to add/set exit code.
98	* change: rename themes --theme <3d|blackwhite|flat>.
99	* change: --no-names and --no-descriptions mutually exclusive (via lia).
100	* change: quote only checklist output items if necessary. Previously
101	    also radiolist item.
102	* change: dialogs with user input print always values except with ERROR,
103	    ESC, Cancel. Previously the situation was quite heterogeneous.
104	* improve: DIAGNOSTIC messages adding fmt string errors.
105	* improve: disable theme setting (opt and env) with no-color terminals.
106	* improve: menus on|off status (strcasecmp, diagnostic, real off check).
107	* improve: --bikeshed with button delimiter and --date-format.
108	* improve: --textbox accepts button options.
109	* improve: Forms with Help button.
110	    - print "HELP" (like menus).
111	    - accept --help-list-items.
112	    - accept --help-print-name.
113	* fix: --load-theme attributes.
114	* fix: --clear-screen with --and-dialog.
115	* delete: --theme <bsddialog> (partially implemented).
116	* delete: --esc-return-cancel (replaced by new env and option).
117	* delete: --generic-button1 (replaced by --right1-button).
118	* delete: --generic-button2 (replaced by --right2-button).
119	* refactor: modularize in more files (main, cli, builders, theme).
120
121	Library:
122	* add: bsddialog_inmode().
123	* add: bsddialog_clear(y) for utility --clear-screen.
124	* add: bsddialog_refresh() for utility terminal mode options.
125	* add: conf.date.format="d/m/y"|"m/d/y"|"y/m/d" to customize
126	    bsddialog_datebox() UI (boxes) with a date format.
127	* add: 'const char *end' to bsddialog_gauge().
128	* add: draw focus on the shortcut-key-selected button at exit.
129	* add: escapes for conf.text.highlight \Zd, \Zk, \Zs, \ZD, \ZK, \ZS.
130	* add: other theme flags.
131	    - BSDDIALOG_BLINK.
132	    - BSDDIALOG_HALFBRIGHT.
133	    - BSDDIALOG_HIGHLIGHT.
134	* add: generic buttons.
135	    - conf.button.left1_label, BSDDIALOG_LEFT1 return value.
136	    - conf.button.left2_label, BSDDIALOG_LEFT2 return value.
137	    - conf.button.left3_label, BSDDIALOG_LEFT3 return value.
138	    - conf.button.right1.label, BSDDIALOG_RIGHT1 return value.
139	    - conf.button.right2.label, BSDDIALOG_RIGHT2 return value.
140	    - conf.button.right3.label, BSDDIALOG_RIGHT3 return value.
141	* add: unused bsddialog_menugroup.min_on for future features.
142	* add: theme.menu.f_prefixcolor and theme.menu.prefixcolor.
143	* improve: check (when possible) API pointers.
144	* improve: circolar buttons with left and right keys for msgbox, yesno,
145	    menus, rangebox and pause.
146	* improve: bsddialog_textbox() handles conf.buttons.
147	* improve: bsddialog_datebox() a box change affects the others as well.
148	* improve: bsddialog_geterror() with fmt strings.
149	* change: API NULL strings handled like "", except gauge *sep and *end.
150	* change: menus and form less restrictive with text, hide text with
151	    little screens (same behavior as other dialogs).
152	* change: mixedgauge BSDDIALOG_MG_BLANK does not draw minibar but prints
153	    minilabel. The change allows mixedgauge to add sections. To restore
154	    the previous behavior setting minilabel to "".
155	* change: check/set bsddialog_gauge() perc max 100.
156	* change: check/set bsddialog_mixedgauge() mainperc max 100.
157	* change: conf.menu.no_name and conf.menu.no_desc mutually exclusive.
158	* change: bsddialog_pause() sec -> *sec to know remaining time at exit.
159	* change: add *focusitem to bsddialog_form() like menus.
160	* change: "pointer" values are always set except when BSDDIALOG_ERROR
161	    occurs. Examples *yy/*mm/*ss, rangebox *value.
162	    - delete conf.menu.on_without_ok.
163	    - delete conf.form.value_without_ok.
164	* rename: conf.text.highlight -> conf.text.escape.
165	* rename: theme.menu.namesepcolor -> theme.menu.sepnamecolor.
166	* rename: theme.menu.descsepcolor -> theme.menu.sepdesccolor.
167	* fix: bsddialog_pause() elevation bar after resize.
168	* fix: bsddialog_textbox() key '0'.
169	* fix: timebox.c checksize (boxes width).
170	* fix: extend menurows after shrink and enlarge.
171	* fix: menu pad and form pad "re-expansion" after shrink and enlarge.
172	* fix: shadow top-left corner (trick wresize() before wmove()).
173	* fix: increment bsddialog_total_progview size for more general use.
174	* delete: BSDDIALOG_THEME_BSDDIALOG (partially implemented).
175	* delete: conf.button.generic1_label (for new conf.button.right1_label).
176	* delete: BSDDIALOG_GENERIC1 return value (new BSDDIALOG_RIGHT1).
177	* delete: conf.button.generic2_label (for new conf.button.right2_label).
178	* delete: BSDDIALOG_GENERIC2 return value (new BSDDIALOG_RIGHT2).
179	* delete: bsddialog_clearterminal(), replaced by bsddialog_clear(y).
180	* refactor: internal implementation.
181	    - add: internal structures to represent components.
182	    - merge: (when possible) dialogs autosize.
183	    - merge: (when possible) dialogs checksize.
184	    - merge: for each dialog "build" with "update" -> <dialog>_redraw().
185	    - merge: new_dialog() with update_dialog() -> draw_dialog().
186	    - merge: infobox.c with messagebox.c (delete infobox.c)
187	    - merge: bsddialog_datebox() + bsddialog_calendar() -> datebox.c
188	    - change: flat and blackwhite real themes, 3d adapted from flat.
189	    - improve: replace wrefresh() -> wnoutrefresh()/doupdate().
190	    - improve: replace prefresh() -> pnoutrefresh()/doupdate().
191	    - improve: menu split code to build private items.
192	    - improve: form split code to build private items.
193	    - delete: -Wno-implicit-fallthrough.
194
195
1962023-06-12 Version 0.4.2
197
198	Library:
199	* fix: compile error with aarch64-gcc12 for "\Z[0-7]" check;
200	    https://gitlab.com/alfix/bsddialog/-/issues/5.
201	* fix: BSDDIALOG_FIELDCURSOREND with multiple items
202	    (warning aarch64-gcc12).
203
204
2052023-01-02 Version 0.4.1
206
207	Utility:
208	* fix: default space separator menus output, except if --separator " ".
209	* rename: GNUMakefile to GNUmakefile to simplify linux build.
210	    Thanks to https://gitlab.com/alfix/bsddialog/-/merge_requests/2.
211
212	Library:
213	* fix: t.dialog.linelowercolor no bold-black, some terminal draws grey.
214	* fix: text wrapping (actual string length) with --colors.
215	* rename: GNUMakefile to GNUmakefile to simplify linux build.
216	    Thanks to https://gitlab.com/alfix/bsddialog/-/merge_requests/2.
217
218
2192022-09-24 Version 0.4
220
221	Utility:
222	* add: --normal-screen to set normal mode.
223	* add: --alternate-screen to set alternate mode.
224	* add: --keep-tite as --alternate-screen alias.
225	* add: --and-dialog to build other dialogs.
226	* add: --and-widget as --and-dialog alias.
227	* add: --no-names (--no-tags becomes alias).
228	* add: --no-descriptions (--no-items becomes alias).
229	* add: --help-print-name (--help-tags becomes alias).
230	* add: --item-bottom-desc (--item-help becomes alias).
231	* add: --cr-wrap (was partially implemented) to keep '\n' with "\n".
232	* add: --text-unchanged to avoid default modification.
233	* add: --tab-escape to enable "\t" in text.
234	* add: --clear-screen to clear the screen.
235	* add: --clear-dialog to clear the dialog (was --clear).
236	* add: --calendar dialog to select a date.
237	* add: DIAGNOSTICS messages for bad arguments number.
238	* add: DIAGNOSTICS messages for missing and unexpected options.
239	* change: --clear becomes alias for --clear-screen.
240	* change: --print-maxsize format output.
241	* change: --menu, --radiolist, --checklist and --treeview output.
242	    - no printed items with Cancel or ESC.
243	    - --separator prints <sepstr> before each item except HELP.
244	    - --separator and --separate-output print <sepstr> after each item.
245	    - quoted item name/desc only when needed.
246	    - --menu avoids to print selected item after focused HELP item.
247	* change: text default modification.
248	    - without a "\n": '\t' -> space, '\n' -> '\n', trim spaces.
249	    - with a "\n": '\t' -> space, '\n' -> space, "\n" -> '\n', no trim.
250	    - delete '\n' after "\n" (also with --cr-wrap).
251	* change: --datebox input and output format yy/mm/dd -> dd/mm/yy.
252	* delete: --no-collapse (partially implemented).
253	* delete: --no-nl-expand (partially implemented).
254	* delete: --trim (partially implemented).
255
256	Library:
257	* add: bsddialog_msgbox() HOME, END, PPAGE and NPAGE keys.
258	* add: bsddialog_yesno() HOME, END, PPAGE and NPAGE keys.
259	* add: bsddialog_menu() SPACE key (equivalent to ENTER).
260	* add: bsddialog_calendar() to select a date.
261	* change: rename enum bsddialog_grouptype -> enum bsddialog_menutype.
262	* change: fixed-menurows becomes at most menurows (depending on text).
263	* change: fixed-rows becomes at most rows, min(rows, screenH - shadow).
264	* change: fixed-cols becomes at most cols, min(cols, screenW - shadow).
265	* delete: undocumented internal bsddialog_menuitem.depth factor (was 2).
266
267
2682022-08-29 Version 0.3
269
270	Utility:
271	* add: --textbox accepts options for the first button.
272	* add: --columns-per-row for text autosizing.
273	* add: --load-theme to read and set a custom theme at runtime.
274	* add: --save-theme to save current theme.
275	* add: --bikeshed for random settings.
276	* add: --switch-buttons to enable buttons/input widgets focus switching.
277	       Available for: --form, --inputbox, --mixedform, --passwordform,
278	       --passwordbox, --timebox and --datebox.
279	* change: rename --esc-cancelvalue to --esc-return-cancel.
280	* change: form field value is printed like multibyte charachter string,
281	          previously widechar string.
282	* change: --timebox output with zero padding.
283	* change: --datebox output mm and dd with zero padding.
284	* fix: --hline with empty string.
285	* fix: avoid to overlay the backtitle by setting a top margin.
286	* fix: avoid to overlay down shadow with menus and forms bottomdesc
287	       by setting a down margin.
288	* fix: --form read-only flag with multiple fields.
289
290	Library:
291	* add: conf.auto_topmargin and conf.auto_downmargin.
292	* add: bsddialog_textbox() accepts conf.button.* for the first button.
293	* add: bsddialog_textbox() arrows and percentage.
294	* add: conf.text.cols_per_row to set a ratio for text autosizing.
295	* add: timebox and datebox arrows and focus background for boxes.
296	* add: timebox and datebox UP key to switch focus.
297	* add: bsddialog_init_notheme() in bsddialog.h.
298	* add: bsddialog_hascolors() in bsddialog_theme.h.
299	* add: theme.form.bottomdesccolor and theme.menu.bottomdesccolor.
300	* add: conf.button.always_active to disable buttons/input-boxes switch.
301	* add: dynamic buttons margin.
302	    - add: theme.button.minmargin and theme.button.maxmargin.
303	    - delete: theme.button.hmargin.
304	* add: Unicode.
305	    - UI handles multicolumn charachters: backtitle, title,
306	      text (word wrapping, autosizing), menus (shortcuts, name, desc),
307	      forms (label, field), textbox, mixedgauge (minilabel),
308	      buttons (label, shortcuts), bottomtitle.
309	    - API handles char* arguments like multibyte charachter string,
310	      depending on the current locale.
311	    - Internally wide charachters are used to get input from keyboard
312	      and to adapt word wrapping and dynamic text autosizing to
313	      muticolumn charachters.
314	* refactoring: (rewrite) form.c.
315	    - delete: libformw dep implementing its features from scratch.
316	    - delete: maxvaluelen >= valuelen constraint.
317	    - delete: conf.form.enable_wchar, get always unicode (wchar) input.
318	    - add: KEY_HOME, KEY_END, KEY_PPAGE, KEY_NPAGE keys in field.
319	    - add: KEY_UP can move focus from buttons to fields.
320	    - add: KEY_DOWN can move focus from item to buttons, if nitem is 1.
321	    - add: conf.form.securembch secure multibyte charachter.
322	    - add: BSDDIALOG_FIELDNOCOLOR for formitem.flags.
323	    - add: BSDDIALOG_FIELDCURSOREND for formitem.flags.
324	    - add: BSDDIALOG_FIELDEXTEND for formitem.flags.
325	    - add: BSDDIALOG_FIELDSINGLEBYTE for formitem.flags.
326	    - add: resizing and refresh after KEY_RESIZE (SIGWINCH).
327	    - add: items scrolling.
328	    - add: conf.form.value_wchar, value is wchar_t* instead of MB-char*.
329	    - add: formheight autosizing.
330	    - add: dynamic item position.
331	* fix: bsddialog_gauge() with fd < 0.
332	* fix: bsddialog_gauge() refresh new text.
333	* fix: internal segmentation fault with disabled shadow.
334	* fix: center position without shadow.
335	* fix: bsddialog_infobox() with zero text length.
336	* fix: text wrapping with more than 1024 words.
337	* fix: rename theme.shadow.h to theme.shadow.y.
338	* fix: rename theme.shadow.w to theme.shadow.x.
339	* fix: menurows autosize with fixed rows improving text_size().
340	* fix: messagebox.c scrolling and checksize without text.
341
342
3432022-03-02 Version 0.2
344
345	Utility:
346	* add: (this) CHANGELOG.
347	* add: "menus" print item with focus (except with OK and ERROR).
348	* add: pause.sh example.
349	* add: timebox.sh example.
350	* change: --theme name "default" -> "flat".
351	* delete: treeview.sh example.
352	* fix: --separate-output does not quote (except with --quoted).
353	* fix: --datebox and --date-format month in output.
354	* improve: examples handle exit status.
355
356	Library:
357	* add: conf.form.enable_wchar for wide characters in bsddialog_form().
358	* add: theme.menu.f_selectorcolor.
359	* add: formw.c example.
360	* change: move conf.f1_file and conf.f1_message in conf.key.
361	* change: theme.button.[left|right]ch -> theme.button.[left|right]delim.
362	* change: theme.button.space -> theme.button.hmargin.
363	* change: theme.menu.arrowcolor -> theme.dialog.arrowcolor.
364	* change: internal bsddialog_menuitem.depth factor 4 -> 2.
365	* fix: disable HOME, PPAGE, END and NPAGE keys in bsddialog_form().
366	* fix: visible cursor for timebox.c and form.c in VM VirtualBox.
367	* fix: mixedlist, center position of separator with big pad.
368	* fix: timebox and datebox set values only with BSDDIALOG_OK.
369	* fix: menurows autosize with fullscreen.
370	* fix: bar color with 0%.
371	* fix: bar label position.
372	* improve: timebox and datebox navigation (keys, buttons and shortcuts).
373	* improve: "menus" colors for accessibility.
374
375
3762022-01-27 Version 0.1
377
378	* Options: --ascii-lines, --backtitle <backtitle>, --begin-x <x>,
379	  --begin-y <y>, --cancel-label <label>, --clear, --colors, --cr-wrap,
380	  --date-format <format>, --defaultno, --default-button <label>,
381	  --default-no, --default-item <name>, --disable-esc,
382	  --esc-cancelvalue, --exit-label <label>, --extra-button,
383	  --extra-label <label>, --generic-button1 <label>,
384	  --generic-button2 <label>, --help, --help-button,
385	  --help-label <label>, --help-status, --help-tags,
386	  --hfile <filename>, --hline <string>, --hmsg <string>, --ignore,
387	  --insecure, --item-depth, --item-help, --items-prefix,
388	  --max-input <size>, --no-cancel, --nocancel, --no-collapse,
389	  --no-items, --no-label <label>, --no-lines, --no-nl-expand,
390	  --no-ok, --nook, --no-shadow, --no-tags, --ok-label <label>,
391	  --output-fd <fd>, --output-separator <sep>, --print-maxsize,
392	  --print-size, --print-version, --quoted, --separate-output,
393	  --separator <sep>, --shadow, --single-quoted, --sleep <secs>,
394	  --stderr, --stdout, --tab-len <spaces>,
395	  --theme <blackwhite|bsddialog|default|dialog>,
396	  --time-format <format>, --title <title>, --trim, --version,
397	  --yes-label <label>.
398	* Dialogs: --checklist, --datebox, --form, --gauge, --infobox,
399	  --inputbox, --menu, --mixedform, --mixedgauge, --msgbox,
400	  --passwordbox, --passwordform, --pause, --radiolist, --rangebox,
401	  --textbox, --timebox, --treeview, --yesno.
402	* Manuals: bsddialog.1, bsddialog.3.
403