[main] Ignore --show-splash while deactivated

The last thing we want to do after plymouth deactivate is called by
the X display manager is listen to calls to show the splash screen
again.

So don't.

[main] Ensure second quit blocks until quit processed

When it comes to quitting, which must be carefully coordinated
with other subsystems during the boot process, we need to make
sure the client doesn't return early.

[main] Ensure second deactivate blocks until deactivation

When it comes to deactivation where the various steps of boot
have to be carefully synchronized, we need to make sure that
the client doesn't return early.

[main] fix bug with multiple quit commands

Likewise if plymouth quit is called when we're waiting for the boot
splash to become idle, we also end up asserting that there's not
already an idle trigger.

Fix it in the same way as deactive, ignore the second quit command
except for pulling its trigger.

[main] fix bug with multiple deactivate commands

If plymouth deactivate is called when we're waiting for the boot
splash to become idle, we end up asserting that there's not
already an idle trigger.

Fix it by checking for an existing deactive trigger, and if there
is, ignoring the new deactivate command (except for pulling its
trigger so it doesn't block).

[main] pull deactivate trigger in quit_program()

To avoid a "plymouth deactivate" command hanging forever in the case
of the program quitting, pull the trigger before the quit trigger.

[main] give quit command precedence over deactivate

In the cases where the boot splash plugin does not become idle
immediately, we go back into the main loop and can receive additional
commands.

Since quit and deactive both use this facility, one scenario is the
quit command arriving after the deactivate command, but before the
deactivate command has actually been run.

In that situation, we want to quit, not deactivate.

[terminal] Add spew for multiple opens and closes

It may help with debugging problems later on.

[branch-merge] Improved VT Handling

One of the main differences between Ubuntu's use of Plymouth and
Fedora's is that on Ubuntu we've tried to keep the X server on VT7
so that the historical documentation of Ctrl-Alt-F1 giving you a
text console is preserved.

This obviously means that for a smooth transition, Plymouth must also
run on VT7.

We discovered that although Plymouth does have code to attempt to deal
with VTs, none of it is quite right and there are many paths that don't
work unless Plymouth is run on VT1.

This patch set fixes our known problems with the VT handling making it
possible to run Plymouth on any VT of your choosing, with VT1 remaining
the default.

[configure] allow boot and shutdown ttys to be changed

Allow distributions like Ubuntu to override the boot and shutdown
ttys from the configure script so they don't have to patch the
source.

[main] add --tty command-line option

Add a command-line option to specify the TTY that plymouth should
use.  This is mostly useful for debugging, for example you can put
plymouth onto a TTY not used by the X server; or if you're feeling
particularly sneaky, plymouth into an xterm.

[terminal] guard open and close against repeated calls

Since we have a status flag whether or not the terminal fd is open,
use it in the open and close functions to guard against repeated
calls.

[x11] default renderer to inactive

Change the renderer so that it defaults to inactive until we
map to the device.

[frame-buffer] default renderer to inactive

Change the renderer so that it defaults to inactive, then when we
map to the device, activate the renderer by activating the VT;
unless the VT is already active in which case activate the
renderer directly.

[drm] default renderer to inactive

Change the renderer so that it defaults to inactive, then when we
map to the device, activate the renderer by activating the VT;
unless the VT is already active in which case activate the
renderer directly.

[terminal,text,details] move activate vt into plugins

Move the responsiblity to activate the VT into the text and details
plugins; this not only matches the graphical renderers, but it also
ensures we activate the VT in all possible code paths.

Previously if we fell back to text.so because we couldn't activate
a renderer, this would not activate the VT.

[x11] ignore terminal completely

The X11 renderer doesn't need a terminal at all, so we ignore it
completely.

[frame-buffer] don't run on non-virtual terminals

We only need support DRM on virtual terminals, those that are not
such as serial consoles, can be trivially skipped.

[drm] don't run on non-virtual terminals

We only need support DRM on virtual terminals, those that are not
such as serial consoles, can be trivially skipped.

[terminal] move terminal opening into renderers/plugins

Move the responsibility to actually open the terminal to the renderers
and text/details plugin, this allows the X11 renderer to not actually
open the terminal - and thus not crash the X server.

[terminal] don't treat ttySx as VT

Only devices with TTY_MAJOR and minor from 0-63 are VTs, 64 onwards
are serial consoles.

[terminal] drop next_active_vt

When we activate our VT, now we actually have it in VT_PROCESS not the
VT we started from, we get the proper signal so don't need an ioctl to
wait until its active.

If we were to leave our VT, we'd get the opposite signal as well and
we don't really care whether we actually get to the other VT, just
that we leave ours.

And this code was in the wrong place anyway.

[terminal] don't keep track of active vt, just if vt is active

Trying to keep track of whatever VT is actually active is inherently
racy; instead just keep track of whether our VT is the active one.
Since we guarantee that's the VT in VT_PROCESS now, this is easy.

Rather simplifies the on_vt_changed functions in renderers too.

[terminal] drop support for opening the foreground terminal

This isn't used anywhere in plymouth, we should always open a named
terminal to avoid surprises due to VT switches we're not watching
for.

[terminal] only support vt-like operations on VTs

Now we can simply test whether a terminal is virtual or not, add
a guard in the mode and vt change functions that ensure they only
operate on virtual terminals.

[terminal] add ply_terminal_is_vt() function

We want to be able to query whether a terminal is an ordinary terminal
or a virtual terminal, rather than looking up the vt number and knowing
what the right numbers are, add a function that knows that.

[terminal] replace set_active_vt with activate_vt

Since a terminal already knows which VT number it is, there's no
need to accept a VT number for switching to this VT.

[console] remove console files

Now that everything's switched over to using ply_terminal_t, we
can remove the console files.

[terminal] remove references to ply_console_t

Remove all of the references to ply_console_t from the code, now
we operate exclusively on the terminal object.  In some places
this means switching from one to the other, but in many it just
means dropping the console object and using the terminal object
we were already passed.

[terminal] merge console and terminal code

This removes the separation in code of "console" functions and
"terminal" functions; this never really made sense, and doesn't
particularly map to the behaviour of Linux virtual terminals.

The three principle operations that Plymouth was using "console"
for were:

 * changing the active VT
 * notification of changes to the active VT through VT_PROCESS
 * switching between text and graphics mode

And it was using the "foreground terminal" alias /dev/tty0 to do
this.  While this is fine for the first of those, since any console
device will do, it's always wrong for the latter two which should
always be on the actual VT we want Plymouth to run from.

If running on tty7, only tty7 should be in VT_PROCESS mode (since
we want to know when we enter this VT and leave this VT), and
certainly only tty7 should be in graphics mode.

Since you can use that same tty to obtain the current active VT,
and switch VT, you don't need another; so the need for a separate
"console" functionality goes away.

[main] unset keyboard if splash fails to show

Since script implements a set_keyboard function (the only plugin to
do so), the previous commit reveals a bug where set_keyboard is
called for the plugin but unset_keyboard isn't called if the plugin
fails to be loaded

[script] check that there are pixel displays

The script plugin only works on pixel displays, however there wasn't
any check for this, so if a script-based theme was your default
Plymouth would not fallback to using the text plugin instead.

[terminal] change fallback terminal settings

I think when I originally added the fallback case, I looked at the
tcgetattr man page, saw cfmakeraw()'s settings and just inverted them.

That's obviously wrong.  These settings should hopefully make a little
more sense.

Spelling fix for manpage.

[script] Add SubString function to the script string library

Adds the SubString function which returns a string segment. The two paramiters
are the sub-string start and end indicies. Negative start and end values return
a NULL, as does start index being beyond the end index. Start being beyond the
end of the string returns an empty string.

[drm] reconnect input source on disconnect

This is like 6f8d51c2cb2f46eac4c2040f5fc8512f65c8d2da
but for the drm renderer.

[frame-buffer] reconnect input source on disconnect

This is like 1425549885aadb21871d1751d71f411cce802d60
but for the frame buffer renderer.

Merge branch 'scriptftbfs'

Merge branch 'scriptdirs'

[main] replace tabs with spaces

Missed these in the clean-up pass.

[script] drop unused on_draw() function

The on_draw() function inside the script plugin isn't referenced
anywhere, but references a static function from script-lib-sprite.c;
if building without optimisation, it's possible that gcc won't elide
this code so will fail during linking.

[scripts] Don't hardcode LIBEXECDIR and DATADIR paths

The scripts hard-coded the paths for LIBEXECDIR and DATADIR, unless
passed as environment variables.  Instead of doing this, which breaks
if plymouth is installed outside of /usr, set these derived from the
configure $libexecdir and $datadir variables just as we do for
pkg-config, etc.

Since we use so many variables, it makes more sense to generate these
scripts from config.status rather than having special Makefile rules
for them.

[main] Write the pid of plymouthd to a file

Add a --pid-file option to plymouthd that will cause the daemon's
pid to be written to the named file.  Useful to avoid grovelling
through ps output to find it again.

[client] Install libply-boot-client library and headers

When communicating with Plymouth from another process, it's
inconvenient to have to keep spawning the plymouth client binary
and keeping track of it - not to mention slow.

It's far cleaner to be able to link to the same boot client code
that the plymouth binary does, and communicate directly.

Place that code in a new libply-boot-client library, and install
the headers along with it.

[keyboard] Handle tty hangup better

We currently reconnect the terminal object on tty disconnects,
but we don't rewatch the keyboard. A disconnect will invalidate
the fd watch, so we need to handle it to prevent crashes.

[server] Add debugging statements

[libply-splash-core] Install to / instead of /usr

Since plymouthd links against this library, we should
probably move it to /lib if plymouthd is installed in
/sbin

[main] Defer password requests to client if daemon unavailable

There are times when plymouthd isn't in a position to ask for
the password (for instance, if the initramfs is about to run
init=/bin/bash or something).  In those cases, any password
requests need to be handled by the client.

[main] Send CTRL-C instead of NULL for password cancel

We'll want to use NULL for "daemon can't ask"

[client] add debugging statements

[client] Run ask-for-password command unconditionally

Even if we can't contact the daemon, we should still run the
ask-for-password command.  This is because the command may
do things important for boot up to continue like unlocking
the root partition.

[client] Don't exit right away if daemon unavailable

We're going to want to be able to carry on in some cases
even if the daemon isn't there.

[client] debug mode if plymouth:debug in /proc/cmdline

We currently do this for the daemon.  We should do it for
the client as well.

[script] Add get functions for all sprite properties

Adds GetImage/X/Y/Z/Opacity to get the current values of the sprites.
This is for convenience of not having to store them in the script.

[script] Use floor when implementing Int

Previously the Math.Int function converted to int and back to double.
The floor function works larger than those represented by integers and it
correctly handles NaN and Inf.

[script] Add a random number generator

Adds Math.Random() which returns a random number between 0 and 1.

[daemon] drop libply-splash-graphics dependency

[branch-merge] Drop libpng requirements from base install

Right now, plymouthd links against libplybootsplash which links
against libpng.  Only graphical splashes use libpng, but it's
always pulled in.

This merge splits libplybootsplash into two libraries: the core
bits, and the extractable graphical bits.  Only the graphical splashes
link against the latter library.  This way server installations can
get plymouth without pulling in libpng.  This will reduce the amount
of security errata deployed to those server installations.

[splash] Split out graphical parts of libply-splash-core

We now have a libply-splash-graphics for handling the
graphical bits.  In particular, this means plymouthd no
longer links against libpng.

[splash] Rename libplybootsplash to libply-splash-core

Splashes aren't just shown for "boot" so including "boot" in
the name isn't right.  Also, right now we link against libpng
even if we don't have any splash that uses it.  This is the first
step toward making libpng only get linked to graphical splashes.

We'll need to move the graphical bits to their own library to
complete the process.

[details] don't include ply-image.h

[main] quit program when quit given after deactivate

If plymouth quit (without --retain-splash) follows plymouth deactivate,
plymouth will never actually quit (or pull the trigger for the client)

[main] avoid crash when no splash running

We haven't saved the passed deactivate trigger to the state,
so it won't be set there.  Just pull it directly.

[main] Don't free renderer when NULL

If we weren't showing the splash screen, we'll have no renderer

[branch-merge] Add man page

This merges the "man-page" branch to master.

Thanks to Adrian Glaubitz we now have a man page for plymouth.

This is a good start to documenting the basics of plymouth.

We'll eventually need more comprehensive reference documentation
before 1.0 is released, and now we have some of the ground work
(a docs/ directory) for that.

[docs] Remove commented out section from man page

We don't have a --version and it was adding a gap in the output

[docs] Update home page url in man page

[docs] Fix AUTHORS in man page

[docs] Clarify "rhgb" cmdline option in man page

Previously, it said that "rhgb" was required for plymouth
to run, but plymouth runs no matter what.  This just
specifies which splash is displayed

[docs] Remove instructions about boot loader

They weren't completely accurate, you don't need to reinstall
grub after editing its config, since it has built-in filesystem
drivers.  Also, those details very from system to system, so we
should probably just leave it out.

[docs] Add reference to splash cmdline in man page

It referenced rhgb, but not splash.  While rhgb was
there first, most distributions use splash since it's
more logical (among other reasons).

[docs] Remove distribution references from man page

We don't want to provide a history of what distributions
used before plymouth, because that history could get long,
isn't super relevant, and will add noise for a users looking
for help (they probably only care about their distributions,
not others).

[docs] Rename man/ to docs/

This way we can put other documents there as well.

[docs] Add man page

It explains the basic concepts of plymouth and the usage of tools to be
used to setup it.

[set-default-theme] Provide GNU-style short options

[set-default-theme] Make --help format match that of plymouth and plymouthd

Minor rejig to make the help messages more consistant. Also removes some tabs
and empty lines.

[set-default-theme] Call usage function in --help

This way the top line of the help output gives usage.

[set-default-theme] Add --help option

When running new, unfamiliar commands I usually invoke them with
--help to see what options they have. For plymouth-set-default-theme,
there is no --help option which I find a bit confusing, especially
since the usage is not straight-forward.

There is now an additional function "show_help" which displays an
help output when invoking plymouth-set-default-theme with --help.

[main] Fix fd leak

When redirecting stdio to the tty, the
tty was opened and its fd was dup()'d to
the standard ones, but then wasn't closed.

[script] Add widow get position functions

These are the Window.GetX/Y that pair up with Window.SetX/Y already present.
They return the position of the window.

[configure] Make maintainer mode default to on but not explicit in autogen

Maintainer mode is assumed on when executing configure, and thus is not needed
within autogen.

[viewer] Quit on window close when not in icon mode.

Previously, in non-icon mode when clicking on the window decoration close, the
window would hide and carry on running. It should quit.

https://bugs.freedesktop.org/show_bug.cgi?id=20228

[fade-throbber] Draw password dialog even if not animating

If is_animating was not set, the draw would quit before drawing the dialog.

[script] Pass color to the text renderer

We collected the color information before, but did nothing with it.

[label] Add color control

Previously we drew two overlapping labels, one in black and one in white, to
make sure it was vsible on all backgrounds. Now we can pick an appropreate
color for each theme. The default is white. If changing the label color once it
has been shown, it will redraw that part of the screen.

[script] Allow setting the position of the windows

Although the windows are set up to in a reasonable default configuration, the
themes may align the windows differently to not crop some important elements.

The Window.SetX and SetY allow positioning the window anywhere on the canvas.
Use this sparingly as it induces a full refresh of all screens.

If there is a desire to have totally different scenes, the second window can be
positioned somewhere far away so there is overlap and a complete different set
of sprites is used. Another sensible configuration is to have the screens side
by side and allow sprites to span the gap. Remember to create password dialogs
for each screen as not all may be visible.

[script] Handle multiple displays with one script instance

When multiple displays were introduced, each display had its own script plugin
instance. This made things easy as the scripts would not have to be rewritten
for multiple screens. Unfortunately this also meant that each image was loaded
multiple times, and the scripts consumed much more processing power.
Additionally the scripts were not aware of each other.

This patch allows a single script instance to control multiple displays while
maintaining reasonable backward compatibility. All sprites are placed on a
virtual canvas. Displays (or windows) then expose parts of this canvas to the
user.

As a default, window 0 is placed at 0,0. Further windows are placed on top of
the window 0 area matching the centre point so the password dialog (which is
placed in the centre) is visible on all windows. If you target window 0 only
and you place dialogs in the middle of the screen, then everything should work
fine.

Window.GetWidth/GetHeight now takes a window number (if none supplied it will
assume 0). If it replies a NULL, then you accessed beyond the end of the
window set.

[list] Initialise node in the get Nth function

Typo in the previous patch.

[list] Add get Nth node function

Gets the Nth node in the list. If the index is outside the range, it will
return NULL

[list] Add a stable sort

Stable sort sorts but does not change the order of elements which are equal.
This is important in the sprite based plugins where if the level of the sprites
is equal because it may be unimportant which is on top, changing the order
between frames looks bad.

[region] Actually perform the sort when requested

Typo, sort line was missing.

[region] Allow rectangles to be sorted before being fed back

The renderers commit the rectangles derived from the region in a random order.
This gives some tearing as the screen is displayed with a random regions in
their new state. The change sorts the list of rectangles according to their Y
value to commit them from top to bottom. This gives fewer tear lines.

[list] Replace the old sort function with quicksort

It is a simple quicksort implementation which does no randomisation.

[list] Adds tests of the sort function

Sorts 100 random integers. Reports any out of order and returns an error code.

[list] Add test code of the sort function

[branch-merge] Improve plymouth -> X hand off

This merges the "no-fbcon" branch to master.

Previously, the way to get a transition between
plymouth and X was for plymouth to quit,
leaving the tty in KD_GRAPHICS mode, and hope
X starts and picks up the peices.  In this
limbo state where plymouth isn't running but X
isn't started yet the user is unable to
switch VTs or really do anything at all.

If X doesn't start then the user is hosed; they
have to reboot.

Now, instead of quitting plymouth before starting
X we "deactivate" it.  This gets plymouth into a
state where X can take over the display, but
plymouth stays running.  Once X has fully started
up or failed to start the display manager can
tell plymouth to quit (with --retain-splash if
X started successfully and without if X started
unsucessfully)

[client] Add new deactivate subcommand

This tells the daemon we're about to start X with -nr and
to get ready for the transition.

[daemon] deactivate daemon for X transition

In order for plymouth to be able to stay around until
after X is started, we need to put the daemon into a
"deactivated" state where it makes the splash becomes idle
and relinquishes control of the scan out hardware and keyboard
for X to seize.

This commit listens for deactivation requests in the daemon and
performs the deactivation.

A future commit will implement the client bits needed.

[x11] implement new activate/deactivate methods

We disable flushing when inactive.

[frame-buffer] implement new activate/deactivate methods

We basically just do what we were doing before
implicitly on VT switch, explicitly on activate
and deactivate.