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