aboutsummaryrefslogtreecommitdiffstats
path: root/e-util/e-util.h
blob: d1a76c8ea6ea3c77b86e27561ef00b3373f7c4f6 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
/* -*- Mode: C; tab-width: 8; indent-tabs-mode: t; c-basic-offset: 8 -*- */
/*
 * e-util.h
 * Copyright (C) 1999-2008 Novell, Inc. (www.novell.com)
 *
 * Authors:
 *   Chris Lahey <clahey@ximian.com>
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Library General Public
 * License, version 2, as published by the Free Software Foundation.
 *
 * This library 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
 * Library General Public License for more details.
 *
 * You should have received a copy of the GNU Library General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
 * 02110-1301, USA.
 */

#ifndef _E_UTIL_H_
#define _E_UTIL_H_

#include <sys/types.h>
#include <gtk/gtk.h>
#include <limits.h>
#include <gconf/gconf-client.h>
#include <cairo.h>

#include <e-util/e-marshal.h>

G_BEGIN_DECLS

typedef enum {
    E_FOCUS_NONE,
    E_FOCUS_CURRENT,
    E_FOCUS_START,
    E_FOCUS_END
} EFocus;

const gchar *   e_get_user_data_dir     (void);
void        e_display_help          (GtkWindow *parent,
                         const gchar *link_id);
guint       e_load_ui_definition        (GtkUIManager *manager,
                         const gchar *basename);

char *      e_str_without_underscores   (const char *s);
gint        e_str_compare           (gconstpointer x,
                         gconstpointer y);
gint        e_str_case_compare      (gconstpointer x,
                         gconstpointer y);
gint        e_collate_compare       (gconstpointer x,
                         gconstpointer y);
gint        e_int_compare                   (gconstpointer x,
                         gconstpointer y);
gboolean    e_write_file_uri        (const gchar *filename,
                         const gchar *data);

/* This only makes a filename safe for usage as a filename.
 * It still may have shell meta-characters in it. */
gchar *     e_format_number         (gint number);
gchar *     e_format_number_float       (gfloat number);

typedef gint    (*ESortCompareFunc)     (gconstpointer first,
                         gconstpointer second,
                         gpointer closure);

void        e_bsearch           (gconstpointer key,
                         gconstpointer base,
                         gsize nmemb,
                         gsize size,
                         ESortCompareFunc compare,
                         gpointer closure,
                         gsize *start,
                         gsize *end);

gsize       e_strftime_fix_am_pm        (gchar *str,
                         gsize max,
                         const gchar *fmt,
                         const struct tm *tm);
gsize       e_utf8_strftime_fix_am_pm   (gchar *str,
                         gsize max,
                         const gchar *fmt,
                         const struct tm *tm);
const gchar *   e_get_month_name        (GDateMonth month,
                         gboolean abbreviated);
const gchar *   e_get_weekday_name      (GDateWeekday weekday,
                         gboolean abbreviated);

/* String to/from double conversion functions */
gdouble     e_flexible_strtod       (const gchar *nptr,
                         gchar **endptr);

/* 29 bytes should enough for all possible values that
 * g_ascii_dtostr can produce with the %.17g format.
 * Then add 10 for good measure */
#define E_ASCII_DTOSTR_BUF_SIZE (DBL_DIG + 12 + 10)
gchar *     e_ascii_dtostr          (gchar *buffer,
                         gint buf_len,
                         const gchar *format,
                         gdouble d);

/* Alternating char * and int arguments with a NULL char * to end.
   Less than 0 for the int means copy the whole string. */
gchar *     e_strdup_append_strings     (gchar *first_string,
                         ...);

cairo_font_options_t *
        get_font_options        (void);

void        e_file_update_save_path     (gchar *uri,
                         gboolean free);
gchar *     e_file_get_save_path        (void);

gboolean    e_file_lock_create      (void);
void        e_file_lock_destroy     (void);
gboolean    e_file_lock_exists      (void);

gchar *     e_util_guess_mime_type      (const gchar *filename);
gchar *     e_util_filename_to_uri      (const gchar *filename);
gchar *     e_util_uri_to_filename      (const gchar *uri);

gboolean    e_util_read_file        (const gchar *filename,
                         gboolean filename_is_uri,
                         gchar **buffer,
                         gsize *read,
                         GError **error);

G_END_DECLS

#endif /* _E_UTIL_H_ */