xfce4-systemload-plugin-zram/panel-plugin/uptime.h

/*
 * This file is part of Xfce (https://gitlab.xfce.org).
 *
 * Copyright (c) 2003 Riccardo Persichetti <riccardo.persichetti@tin.it>
 * Copyright (c) 2010 Florian Rivoal <frivoal@xfce.org>
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 *
 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

#ifndef _XFCE_SYSTEMLOAD_UPTIME_H_
#define _XFCE_SYSTEMLOAD_UPTIME_H_

#include <glib.h>

gulong read_uptime();

/*
 * Render an uptime (in seconds) through a user format string.
 *
 *   %d days            %h hours (0-23)   %m minutes (0-59)   %s seconds (0-59)
 *   %H %M %S           the same, always two digits ("07")
 *   %t total hours     %% a literal percent sign
 *   \n line break      \\ \{ \} \% the character itself
 *   {...}              the block is dropped when every number inside it is 0
 *
 * Unknown %x sequences and an unclosed '{' are kept as literal text, so a
 * typo is visible on the panel instead of silently disappearing.
 * Returns a newly allocated string; free with g_free().
 */
gchar *format_uptime(const gchar *format, gulong uptime);

#endif /* _XFCE_SYSTEMLOAD_UPTIME_H_ */