From 065658f6b8a178dc63517b81908e300d9f161d84 Mon Sep 17 00:00:00 2001 From: Bryan Ashby Date: Wed, 5 Oct 2022 21:46:13 -0600 Subject: [PATCH] First commit of "advanced" MCI formatting via theme.hjson entries allowing mini-formatting langauge to apply Example: {BN!styleFirstLower} in 'text' property --- core/predefined_mci.js | 19 +++++++ core/text_view.js | 9 ++++ docs/_config.yml | 1 - docs/_docs/art/mci.md | 15 +++--- docs/_docs/art/views/predefined_label_view.md | 49 ------------------- docs/_docs/art/views/text_view.md | 2 +- 6 files changed, 38 insertions(+), 57 deletions(-) delete mode 100644 docs/_docs/art/views/predefined_label_view.md diff --git a/core/predefined_mci.js b/core/predefined_mci.js index 7463186f..01d81d90 100644 --- a/core/predefined_mci.js +++ b/core/predefined_mci.js @@ -22,6 +22,7 @@ const moment = require('moment'); const async = require('async'); exports.getPredefinedMCIValue = getPredefinedMCIValue; +exports.getPredefinedMCIFormatObject = getPredefinedMCIFormatObject; exports.init = init; function init(cb) { @@ -532,3 +533,21 @@ function getPredefinedMCIValue(client, code, extra) { return value; } } + +function getPredefinedMCIFormatObject(client, text) { + const re = /\{([A-Z]{2})(?:[!:][^}]+)?\}/g; + let m; + const formatObj = {}; + while ((m = re.exec(text))) { + const v = getPredefinedMCIValue(client, m[1]); + if (v) { + if (!isNaN(v)) { + formatObj[m[1]] = parseInt(v); + } else { + formatObj[m[1]] = v; + } + } + } + + return _.isEmpty(formatObj) ? null : formatObj; +} diff --git a/core/text_view.js b/core/text_view.js index dcd14c7c..74b622ba 100644 --- a/core/text_view.js +++ b/core/text_view.js @@ -11,6 +11,9 @@ const renderSubstr = require('./string_util.js').renderSubstr; const renderStringLength = require('./string_util.js').renderStringLength; const pipeToAnsi = require('./color_codes.js').pipeToAnsi; const stripAllLineFeeds = require('./string_util.js').stripAllLineFeeds; +const getPredefinedMCIFormatObject = + require('./predefined_mci').getPredefinedMCIFormatObject; +const stringFormat = require('./string_format'); // deps const util = require('util'); @@ -153,6 +156,12 @@ TextView.prototype.setText = function (text, redraw) { text = text.toString(); } + const formatObj = getPredefinedMCIFormatObject(this.client, text); + if (formatObj) { + // expand before converting + text = stringFormat(text, formatObj); + } + this.text = pipeToAnsi(stripAllLineFeeds(text), this.client); // expand MCI/etc. if (this.maxLength > 0) { this.text = renderSubstr(this.text, 0, this.maxLength); diff --git a/docs/_config.yml b/docs/_config.yml index 457a75c3..8520d124 100644 --- a/docs/_config.yml +++ b/docs/_config.yml @@ -92,7 +92,6 @@ collections: - art/views/horizontal_menu_view.md - art/views/mask_edit_text_view.md - art/views/multi_line_edit_text_view.md - - art/views/predefined_label_view.md - art/views/spinner_menu_view.md - art/views/text_view.md - art/views/toggle_menu_view.md diff --git a/docs/_docs/art/mci.md b/docs/_docs/art/mci.md index 0696672b..64c1ee1c 100644 --- a/docs/_docs/art/mci.md +++ b/docs/_docs/art/mci.md @@ -123,11 +123,9 @@ Some additional special case codes also exist: | `XY` | A special code that may be utilized for placement identification when creating menus or to extend an otherwise empty space in an art file down the screen. | -> :information_source: More are added all -the time so also check out [core/predefined_mci.js](https://github.com/NuSkooler/enigma-bbs/blob/master/core/mci_view_factory.js) -for a full listing. +> :information_source: More are added all the time so also check out [core/predefined_mci.js](https://github.com/NuSkooler/enigma-bbs/blob/master/core/mci_view_factory.js) for a full listing. -:memo: Many codes attempt to pay homage to Oblivion/2, iNiQUiTY, etc. +> :memo: Many codes attempt to pay homage to Oblivion/2, iNiQUiTY, etc. ## Views @@ -146,7 +144,6 @@ a Vertical Menu (`%VM`): Old-school BBSers may recognize this as a lightbar menu | `FM` | Full Menu | A menu that can go both vertical and horizontal. | See [Full Menu](views/full_menu_view.md) | | `SM` | Spinner Menu | A spinner input control | Select *one* from multiple options. See [Spinner Menu](views/spinner_menu_view.md) | | `TM` | Toggle Menu | A toggle menu | Commonly used for Yes/No style input. See [Toggle Menu](views/toggle_menu_view.md)| -| `PL` | Predefined Label | Show environment information | See [Predefined Label](views/predefined_label_view.md)| | `KE` | Key Entry | A *single* key input control | Think hotkeys | > :information_source: Peek at [/core/mci_view_factory.js](https://github.com/NuSkooler/enigma-bbs/blob/master/core/mci_view_factory.js) to see additional information. @@ -189,7 +186,7 @@ Predefined MCI codes and other Views can have properties set via `menu.hjson` an | `height` | Sets the height of views such as menus that may be > 1 character in height | | `width` | Sets the width of a view | | `focus` | If set to `true`, establishes initial focus | -| `text` | (initial) text of a view | +| `text` | (initial) text of a view. See | | `submit` | If set to `true` any `accept` action upon this view will submit the encompassing **form** | | `itemFormat` | Sets the format for a list entry. See [Entry Formatting](#entry-formatting) below | | `focusItemFormat` | Sets the format for a focused list entry. See [Entry Formatting](#entry-formatting) below | @@ -219,6 +216,12 @@ Standard style types available for `textStyle` and `focusTextStyle`: ### Entry Formatting Various strings can be formatted using a syntax that allows width & precision specifiers, text styling, etc. Depending on the context, various elements can be referenced by `{name}`. Additional text styles can be supplied as well. The syntax is largely modeled after Python's [string format mini language](https://docs.python.org/3/library/string.html#format-specification-mini-language). +#### MCI Formatting +For more advanced layouts, you may want to apply formatting to MCI codes. In this case, an alternative syntax is supported similar to standard [Entry Formatting](#entry-formatting). MCI codes can be surrounded by `{` and `}` in the `text` field of your `theme.hjson` for a Text Label (`%TL` aka [Text View](./views/text_view.md)). An example: +``` +text: "|00|07{BN!stylel33t}" // render board name in "l33t" text +``` + ### Additional Text Styles Some of the text styles mentioned above are also available in the mini format language: diff --git a/docs/_docs/art/views/predefined_label_view.md b/docs/_docs/art/views/predefined_label_view.md deleted file mode 100644 index b9349a23..00000000 --- a/docs/_docs/art/views/predefined_label_view.md +++ /dev/null @@ -1,49 +0,0 @@ ---- -layout: page -title: Predefined Label View ---- -## Predefined Label View -A predefined label view supports displaying a predefined MCI label on a screen. - -## General Information - -> :information_source: A predefined label view is defined with a percent (%) and the characters PL, followed by the view number and then the predefined MCI value in parenthesis. For example: `%PL1(VL)` to display the Version Label. *NOTE*: this is an alternate way of placing MCI codes, as the MCI can also be placed on the art page directly with the code. For example `%VL`. The difference between these is that the PL version can have additional formatting options applied to it. - -> :information_source: See *Predefined Codes* in [MCI](../mci.md) for the list of available MCI codes. - -> :information_source: See [MCI](../mci.md) for general information on how to use views and common configuration properties available for them. - -### Properties - -| Property | Description | -|-------------|--------------| -| `textStyle` | Sets the standard (non-focus) text style. See **Text Styles** in [MCI](../mci.md) | -| `justify` | Sets the justification of the MCI value text. Options: left (default), right, center | -| `fillChar` | Specifies a character to fill extra space in the view. Defaults to an empty space | -| `width` | Specifies the width that the value should be displayed in (default 3) | -| `textOverflow` | If the MCI is wider than width, set overflow characters. See **Text Overflow** below | - -### Text Overflow - -The `textOverflow` option is used to specify what happens when a predefined MCI string is too long to fit in the `width` defined. - -> :information_source: If `textOverflow` is not specified at all, a predefined label view can become wider than the `width` if needed to display the MCI value. - -> :information_source: Setting `textOverflow` to an empty string `textOverflow: ""` will cause the item to be truncated if necessary without any characters displayed - -> :information_source: Otherwise, setting `textOverflow` to one or more characters will truncate the value if necessary and display those characters at the end. i.e. `textOverflow: ...` - -## Example - -![Example](../../assets/images/predefined_label_view_example1.png "Predefined label") - -
-Configuration fragment (expand to view) -
-``` -PL1: { - textStyle: upper -} -``` -
-
diff --git a/docs/_docs/art/views/text_view.md b/docs/_docs/art/views/text_view.md index 8eaf9478..0475cec9 100644 --- a/docs/_docs/art/views/text_view.md +++ b/docs/_docs/art/views/text_view.md @@ -15,7 +15,7 @@ A text label view supports displaying simple text on a screen. | Property | Description | |-------------|--------------| -| `text` | Sets the text to display on the label | +| `text` | Sets the text to display on the label. See [MCI Formatting](../mci.md#mci-formatting) for information for advanced formatting. | | `textStyle` | Sets the standard (non-focus) text style. See **Text Styles** in [MCI](../mci.md) | | `width` | Sets the width of a view to display horizontally (default 15)| | `justify` | Sets the justification of the text in the view. Options: left (default), right, center |