two-step: Add per mode settings

[thirdparty/plymouth.git] / src / libply-splash-core / ply-boot-splash-plugin.h

/* ply-boot-splash-plugin.h - plugin interface for ply_boot_splash_t
 *
 * Copyright (C) 2007 Red Hat, Inc.
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2, or (at your option)
 * any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA
 * 02111-1307, USA.
 *
 * Written By: Ray Strode <rstrode@redhat.com>
 */
#ifndef PLY_BOOT_SPLASH_PLUGIN_H
#define PLY_BOOT_SPLASH_PLUGIN_H

#include <stdbool.h>
#include <stdint.h>
#include <unistd.h>

#include "ply-buffer.h"
#include "ply-event-loop.h"
#include "ply-keyboard.h"
#include "ply-pixel-display.h"
#include "ply-text-display.h"
#include "ply-trigger.h"
#include "ply-key-file.h"

typedef enum
{
        PLY_BOOT_SPLASH_MODE_BOOT_UP,
        PLY_BOOT_SPLASH_MODE_SHUTDOWN,
        PLY_BOOT_SPLASH_MODE_UPDATES,
        PLY_BOOT_SPLASH_MODE_INVALID,
        PLY_BOOT_SPLASH_MODE_COUNT = PLY_BOOT_SPLASH_MODE_UPDATES + 1,
} ply_boot_splash_mode_t;

typedef struct _ply_boot_splash_plugin ply_boot_splash_plugin_t;

typedef struct
{
        ply_boot_splash_plugin_t * (*create_plugin)(ply_key_file_t * key_file);
        void (*destroy_plugin)(ply_boot_splash_plugin_t *plugin);

        void (*set_keyboard)(ply_boot_splash_plugin_t *plugin,
                             ply_keyboard_t           *keyboard);
        void (*unset_keyboard)(ply_boot_splash_plugin_t *plugin,
                               ply_keyboard_t           *keyboard);
        void (*add_pixel_display)(ply_boot_splash_plugin_t *plugin,
                                  ply_pixel_display_t      *display);
        void (*remove_pixel_display)(ply_boot_splash_plugin_t *plugin,
                                     ply_pixel_display_t      *display);
        void (*add_text_display)(ply_boot_splash_plugin_t *plugin,
                                 ply_text_display_t       *display);
        void (*remove_text_display)(ply_boot_splash_plugin_t *plugin,
                                    ply_text_display_t       *display);
        bool (*show_splash_screen)(ply_boot_splash_plugin_t *plugin,
                                   ply_event_loop_t         *loop,
                                   ply_buffer_t             *boot_buffer,
                                   ply_boot_splash_mode_t    mode);
        void (*system_update)(ply_boot_splash_plugin_t *plugin,
                              int                       progress);
        void (*update_status)(ply_boot_splash_plugin_t *plugin,
                              const char               *status);
        void (*on_boot_output)(ply_boot_splash_plugin_t *plugin,
                               const char               *output,
                               size_t                    size);
        void (*on_boot_progress)(ply_boot_splash_plugin_t *plugin,
                                 double                    duration,
                                 double                    percent_done);
        void (*on_root_mounted)(ply_boot_splash_plugin_t *plugin);
        void (*hide_splash_screen)(ply_boot_splash_plugin_t *plugin,
                                   ply_event_loop_t         *loop);
        void (*display_message)(ply_boot_splash_plugin_t *plugin,
                                const char               *message);
        void (*hide_message)(ply_boot_splash_plugin_t *plugin,
                             const char               *message);
        void (*display_normal)(ply_boot_splash_plugin_t *plugin);
        void (*display_password)(ply_boot_splash_plugin_t *plugin,
                                 const char               *prompt,
                                 int                       bullets);
        void (*display_question)(ply_boot_splash_plugin_t *plugin,
                                 const char               *prompt,
                                 const char               *entry_text);
        void (*become_idle)(ply_boot_splash_plugin_t *plugin,
                            ply_trigger_t            *idle_trigger);
} ply_boot_splash_plugin_interface_t;

#endif /* PLY_BOOT_SPLASH_PLUGIN_H */
/* vim: set ts=4 sw=4 expandtab autoindent cindent cino={.5s,(0: */