label-freetype: Revamp to work better

Recent changes to the freetype plugin made it quite buggy. There
was an infinite loop bug, and also a failure in metrics handling.

There's also a number of outstanding issues:

1. Kerning is not properly applied
2. hidpi displays don't render correctly

Rather than try to tackle all of these problems in a peicemeal way,
this commit substantially reworks the code.

It introduces a ply_freetype_unit_t type for more clearly managing
the fixed point math freetype requires. This type relies on less
than well defined compiler behavior, however, so it may cause issues
down the road.

It consolidates measuring and drawing code to one function, since in
both cases, the same computation needs to happen, and they had
slightly divergent implementations before.

It consolidates font loading code, so we don't end up with two
different font face loading routines, with different dpi values.

It also changes the names of some variables to be clearer in my
mind (like changing the loaded glyph to the name "glyph" instead
of the name "slot")

ply-console-viewer: Don't crash if passed a NULL format

The splash plugins currently call

ply_console_viewer_print (... NULL);

if no prompt message is specified... This leads to crash.

Rather than fixing all the splash plugins, this commit just makes
a NULL format be a noop.

Merge branch 'synchronize-display-updates' into 'main'

ply-boot-splash: Flush display updates at fixed framerate

See merge request plymouth/plymouth!263

ply-boot-splash: Flush display updates at fixed framerate

At the moment the splash plugins have a lot of leeway when
updates can go to the screen. They can pause and unpause
updates by themselves, and draw at any point.

This rope has a little too much slack, it's actually kind
of complicated for the splash plugins to manage drawing
when they have more than one moving part.

For instance, a spinner animation may be drawing autonomously
from the splash plugin itself. To avoid flicker, everything
needs to be synchronized.

This commit adds that synchronization a layer higher than
the plugins themselves, in ply-boot-splash. It accumulates
drawing updates continuously without doing any drawing, until
a given deadline, then flushes the updates out all at once.

Revert "ply-pixel-display: Pause the display and unpause it at a framerate"

This reverts commit 815d3c72e2e4f7299490e43147972e7d31b91d17.

This idea of pausing and unpausing updates at a given framerate is good,
but doing it at the ply-pixel-display level causes a proble with
monitor hotplug.

Merge branch 'fixconsoleviewerrefresh' into 'main'

splash plugins: Better handling the redraw of the console viewer when visible,...

See merge request plymouth/plymouth!257

splash plugins: Better handling the redraw of the console viewer when visible, and the splash state changes

ply-pixel-display: Pause the display and unpause it at a framerate

ply-entry: Don't crash hiding an entry that is already hidden

ply-console-viewer: introduce ply_console_viewer_clear_line ()

ply-console-viewer: Reorder the labels.

When there is less than 1 screenful of lines, the first line now appears at the top, more similar to a terminal emulator

ply-terminal-emulator: Don't reject empty lines

Merge branch 'nullify-borrowed-bytes' into 'main'

ply-buffer: Nullify bytes outside scope block

See merge request plymouth/plymouth!262

ply-buffer: Nullify bytes outside scope block

ply_buffer_borrow_bytes is a new macro to make it possible to
temporarily alter the allocation of the underlying bytes of
a `ply_buffer_t` outside of `ply_buffer_t` specific methods.

This macro works by forcing the caller to use a scope block
to clearly delineate where the allocation modification is
occurring. This macro was inspired by the python `with` feature.

Unfortunately, the macro leaves the bytes initialized outside
the scope block, so there is some temptation to continue messing
with the allocation when it's not allowed.

This commit improves the macro to address that problem by nullifying
the passed in variables at the conclusion of the borrowing scope
block.

Merge branch 'resilientunicode' into 'main'

ply-terminal-emulator: Handle incomplete Unicode characters with more resiliency

See merge request plymouth/plymouth!261

ply-terminal-emulator: Handle incomplete UTF-8 characters better

This commit introduces a state machine to better handle when part
of a UTF-8 character comes in immediately, and the rest of it
comes in later.

It also tries to better handle cases where control characters
are interleaved in the middle of UTF-8 characters.

ply-terminal-emulator: Rename PLY_TERMINAL_SPACES_PER_TAB to PLY_TERMINAL_EMULATOR_SPACES_PER_TAB

ply-rich-text: Remove now unneeded definiton

utils: Rework UTF-8 handling

ply_utf8_character_get_size currently has this odd argument at
the end that is often just set to PLY_UTF8_MAX_CHARACTER_SIZE
and also the function returns magic values for cases where it
can't figure out the size because the byte isn't a leading
byte or is otherwise not valid UTF-8.

That means that API has a nuance to it that makes the code hard
to follow at a light read.

This commit attempts to improve the situation by dropping the
extra argument, and adds a way to get the type separate from the
size for clarity.

At the same time, this commit updates all the callers to use the
new API. There are two cases where the callers are trying to
remove the last character from a UTF-8 string, so this commit
adds a new function to consolidate that logic as well.

ply-buffer: Make ply_buffer_clear fast if called multiple times in a row

ply_buffer_clear memsets over the entire allocation every time it is
run.

This commit makes it only clear the used part of the allocation.

buffer: Add APIs for editing bytes in buffer

This commit adds a few functions for getting at and
using the size, bytes, and capacity of a buffer.

This will make it easier to modify utf8 string on the side and
and update the buffer size afterward.

Merge branch 'fixvtleds' into 'main'

Set the VT keyboard state with KDSKBMODE so that the VT console doesn't change the LED state

See merge request plymouth/plymouth!259

ply-input-device: Handle the keyboard sequence to change VTs

ply-utils: Introduce ply_change_to_vt_with_fd () and ply_change_to_vt ()

When using input devices, set the VT keyboard state with KDSKBMODE so that the VT console doesn't change the LED state

main: Restore terminal line discipline on hide splash

At the moment if a program calls `plymouth hide-splash`
plymouth keeps the terminal in raw mode. That is wrong,
because programs call `plymouth hide-splash` specifically
so they can use the terminal.

This commit makes plymouth restore the terminal to cooked
mode so it's ready for the next program.

Merge branch 'improve-console-viewer-api' into 'main'

ply-console-viewer: Improve API

See merge request plymouth/plymouth!260

ply-console-viewer: Improve API

At the moment injecting data into a console viewer involves calling
ply_console_viewer_parse_lines.

This name isn't optimal, since the data getting injected might not
be a full line at all.

This commit renames it to ply_console_viewer_write, and also adds
a ply_console_viewer_print that adds a printf like function for
convenience.

Merge branch 'terminalwidth' into 'main'

ply-terminal-emulator: Take a maximum_column_count argument that is used in ply_rich_text.

See merge request plymouth/plymouth!256

ply-utils: rename ply_utf8_string_iterator_init to ply_utf8_string_iterator_initialize

ply-rich-text: Rename functions from ending in _init to _initialize

ply-terminal-emulator: Fix terminal emulator accuracy issues, don't pad with the active formatting

ply-terminal-emulator: Require a fixed upfront column count

Some commands really do need to know how wide the terminal is to operate correctly. Without
it long lines don't wrap right and other badness can happen.

This commit addresses the problem by changing the terminal to take both a `number_of_rows`
and `number_of_columns` argument at construct time instead of just a `maximum_line_count`.

In order to properly implement that change, this commit also adds new api to `ply_rich_text_t`
to specify which parts of a run of rich text is read-only and which parts of the run can be
modified.

Changes in this commit were made with assistance from Ray Strode

ply-terminal-emulator: Don't spam the debug logs with the two most-common commands

ply-terminal-emulator: cleanup dead code

Merge branch 'add-redraw-debug' into 'main'

drm: Add new plymouth.set-mode-on-redraws debug option

See merge request plymouth/plymouth!258

drm: Add new plymouth.set-mode-on-redraws debug option

This option forces a modeset every frame

Merge branch 'fixmodifierrepeat' into 'main'

ply-input-device: Handle better when a keyboard sends key-repeat events for held modifier keys

Closes #225

See merge request plymouth/plymouth!255

ply-input-device: Handle modifiers better

At the moment, holding down the shift key sends
key repeat events that lead to the output not
getting properly shifted.

This commit avoids updating modifier state when
the modifer key is held down.

Merge branch 'input-device-debug' into 'main'

ply-input-device: Handle SYN events

See merge request plymouth/plymouth!253

ply-input-device: Add new plymouth.debug-input-devices kernel option

Right now we don't have a lot of debugging information when processing
keyboard events.  I mean we don't want passwords to show up in logs
after all.

Still, it would be useful to have a way to turn the valve on to the
firehose.

This commit adds a plymouth.debug-input-devices kernel option.

ply-input-device: Handle SYN events

If the kernel falls behind a stream of input events, we currently
drop them on the floor.

It seems unlikely that this could ever happen theorhetically since we only
process keyboard events (versus, say, a high frequency stream of pointer
events, or a complex stylus device with inter-related events coming in,
in batches). Nonetheless, there is a report that suggests key events
may be getting dropped.

This commit adds support for handling the backlogged event case, and
hopefully address the bug report.

Merge branch 'config-h-fix' into 'main'

Include config.h automatically

See merge request plymouth/plymouth!254

Include config.h automatically

There are a few files missing #include <config.h>.

That is bad since it means those files don't get debug tracing.

This commit eliminates the pitfall by making sure the file is
included implicitly

Merge branch 'make-random-numbers-random' into 'main'

ply-utils: Add function for getting random number

See merge request plymouth/plymouth!251

two-step: Use new ply_get_random_number function

space-flares: Use new ply_get_random_number function

script: Use new ply_get_random_number function

fade-throbber: Use new ply_get_random_number function

ply-utils: Add function for getting random number

rand() and srand() are we use now and it's not working out too well
because we're seeding correctly in a number of places.

This commit adds one function to do it better.

Problem spotted by @emperor06

Merge branch 'fixplythrobbercrash' into 'main'

ply-throbber: Only set the loop when there is none. Be more flexable if...

See merge request plymouth/plymouth!252

ply-throbber: fully stop the throbber ply_throbber_start () is called after the throbber is stopped with an end animation

Merge branch 'betterxkblogging' into 'main'

ply-device-manager: Better logging of what vconsole variables are read

See merge request plymouth/plymouth!248

ply-device-manager: Better logging of what vconsole variables are read

Merge branch 'dynamickeymapicon' into 'main'

ply-keymap-icon: Create dynamic text for the keymap name if it is not in the pre-rendered file

See merge request plymouth/plymouth!250

ply-keymap-icon: Create dynamic text for the keymap name if it is not in the pre-rendered file

Merge branch 'parsekmsg' into 'main'

Support for displaying logs from /dev/kmsg and the console on the screen, instead of relying on the text on the VT

See merge request plymouth/plymouth!224

space-flares: Get the messages from the console and ply-kmsg-reader, and use ply-terminal-emulator and ply-console-viewer to the display messages

fade-throbber: Get the messages from the console and ply-kmsg-reader, and use ply-terminal-emulator and ply-console-viewer to the display messages

two-step: Get the messages from the console and ply-kmsg-reader, and use ply-terminal-emulator and ply-console-viewer to the display messages

libply-splash-graphics: Introduce new ply-console-viewer control

main: start ply-kmsg-reader, and fix handling ESC key when there are no VTs

Introduce ply-kmsg-reader to read kernel log messages from /dev/kmsg

ply-utils: Add function for getting current kmsg log levels

We need to know two things:

1. What log level threshold to follow when showing kernel messages to
   the console

2. What log level to use if a message comes in without a log level

This commit adds a new function `ply_get_kmsg_log_levels` that
returns those two values.

label-freetype: Add basic support for rich text

Now that the ply-label interface supports rich text, we need to
implement it in the plugins.

This commit changes the freetype plugin to process
rich text in a rudimentary way that picks up colors, but not other
style attributes.

Based on initial work from nerdopolis

label-freetype: Handle utf-8 characters better

The plugin currently assumes all characters are 7 byte ascii.

This commit just adds a mbrtowc call around the text to
handle UTF-8 text somewhat better.

label-freetype: Support monospaced fonts

label-freetype: Allow the label size to be set and calculated even when hidden

label-pango: Add support for set_rich_text

Now that the ply-label interface supports rich text, we need to
implement it in the plugins.

This commit implements it for the pango plugin.

label-pango: Replace characters not supported by fonts with a replacement character

Using a replacement character prevents hexboxes from appearing, which can mess up alignment of monospace fonts

ply-label: Set font before sizing label

This commit makes sure the right font is loaded before sizing the
label, so the size comes out correctly.

ply-label: Add ply_label_set_hex_color () based off of ply_pixel_buffer_fill_with_hex_color for configuration of label text colors

ply-label: Introduce set_rich_text_for_control () for allowing text properties like color to be set within labels

rich-text: Add iterator API

This commit adds a small wrapper around ply_rich_text_get_characters
to make it easier to iterate over every character in a loop.

ply-utils: Add a utf-8 string iterator API

This will make it easier to walk through a string and extract
each character.

Introduce ply-terminal-emulator to handle various console sequences from kernel logging facilities

libply-splash-core: Add class to handle rich text

In order to implement a terminal that supports colors and styles,
we need some way assign colors and styles to text.

This commit adds a new class ply_rich_text_t to handle that.

Code split out of ply-terminal-emulator.c by Ray Strode.

populate-initrd: Ensure a monospace font is in the initrd, along with fonts defined in the theme.

check-format: Trim weird line that's getting added to output

Merge branch 'label-fixes' into 'main'

Label fixes

See merge request plymouth/plymouth!247

label-pango: Handle NULL text better

label: Fix uncrustify spacing error in label

Merge branch 'features/system-reset-mode' into 'main'

Add system-reset splash mode

Closes #148

See merge request plymouth/plymouth!246

Add system-reset splash mode

Merge branch 'renametilebackground' into 'main'

two-step scaled background fixes

See merge request plymouth/plymouth!245

spinfinity: Make the new ScaleBackgroundImage option more visible to theme editors

two-step: Rename ScaleBackgroundWallpaper to ScaleBackgroundImage

two-step: Check for background.png before background-tile.png first, now that the background may not always be tiled

Merge branch 'scaletwostepbackground' into 'main'

two-step: Support a ScaleBackgroundWallpaper to scale the background instead of tiling it

See merge request plymouth/plymouth!243

two-step: Support a ScaleBackgroundWallpaper to scale the background instead of tiling it

Merge branch 'drm-guess-device-scale' into 'main'

drm: Guess device-scale when using simpledrm

See merge request plymouth/plymouth!242

drm: Guess device-scale when using simpledrm

When displaying on a simpledrm kms device the physical dimensions
of the screen are unknown. Use the heuristics from ply_get_device_scale ()
to guess the device scale to avoid rendering things too small
on 4K screens.

Signed-off-by: Hans de Goede <hdegoede@redhat.com>

drm: Add check if the driver used is simpledrm

Add a check to see if the driver used is simpledrm,
this is a preparation patch for adding support to set
device_scale based on heuristics when using simpledrm.

Signed-off-by: Hans de Goede <hdegoede@redhat.com>

drm: Initialize rotation local variable

Initialize rotation local variable to fix the following
false positive compiler warning:

src/plugins/renderers/drm/plugin.c: In function ‘get_primary_plane_rotation’:
src/plugins/renderers/drm/plugin.c:485:31: warning: ‘rotation’ may be used uninitialized [-Wmaybe-uninitialized]
  485 |                 *rotation_ret = rotation;
      |                 ~~~~~~~~~~~~~~^~~~~~~~~~
src/plugins/renderers/drm/plugin.c:419:18: note: ‘rotation’ was declared here
  419 |         uint64_t rotation;
      |                  ^~~~~~~~

Signed-off-by: Hans de Goede <hdegoede@redhat.com>

utils: Add ply_guess_device_scale () helper

Add a ply_guess_device_scale () helper for getting device-scale
when the physical dimensions of the output are not available.

Signed-off-by: Hans de Goede <hdegoede@redhat.com>

Merge branch 'drm-bgrt-scale-fix' into 'main'

drm: Use first output for panel info if there is no builtin display

See merge request plymouth/plymouth!241

two-step: Fix spelling of "different"

Fix "differtent" type, replacing it with "different".

Signed-off-by: Hans de Goede <hdegoede@redhat.com>

drm: Use first output for panel info if there is no builtin display

The two-step renderer uses ply_renderer_get_panel_properties() to get
the device-scale used for the builtin panel, assuming this is most likely
light-up by the firmware on boot and that this is thus also displaying
the bgrt boot splash shown by the firmware at boot.

It needs to know the device-scale for this output so that if hi-dpi
(device-scale=2) rendering is used on the output it can also set
device-scale=2 on the ply_pixel_buffer() used for the bgrt background
so that the pixel-buffer code knows the splash is pre-scaled and
doesn't double it in size making it twice as big as original.

ATM this doubling in size of the splash is exactly what happens
when using a desktop with a hidpi monitor because the drm plugin
does not provide any "panel" properties in this case.

To avoid this fall-back to using the properties of the first
enumerated (connected) output for get_panel_properties().

Signed-off-by: Hans de Goede <hdegoede@redhat.com>

Merge branch 'i18n-fixes' into 'main'

Fix translations after meson conversion

See merge request plymouth/plymouth!240

i18n: Check for NL plymouth.mo file instead of /usr/share/locale existence

setlocale () does not work when there is no locale info for
the selected LANG / LC_MESSAGES. But it does cache the set
LANG / LC_MESSAGES and on subsequent setlocale () calls with
the same LANG / LC_MESSAGES it does not recheck for the locale info.

Thus if the initrd does not have translations then the setlocale ()
call should be delayed to after the chroot so that e.g.
the "Installing Updates..." text, which only is shown after
the chroot, gets translated properly.

So far we have been checking the /usr/share/locale dir exists,
but it is possible that some initrd generators may create
that without the necessary locale info being available.

Instead check for the NL plymouth.mo file, assuming that
if that is available we have all the necessary locale info.

Signed-off-by: Hans de Goede <hdegoede@redhat.com>