fix debian bug #983778, 'Segfault on selecting empty 'X-Face' custom header'
[claws.git] / src / compose.h
1 /*
2  * Sylpheed -- a GTK+ based, lightweight, and fast e-mail client
3  * Copyright (C) 1999-2012 Hiroyuki Yamamoto
4  *
5  * This program is free software; you can redistribute it and/or modify
6  * it under the terms of the GNU General Public License as published by
7  * the Free Software Foundation; either version 3 of the License, or
8  * (at your option) any later version.
9  *
10  * This program is distributed in the hope that it will be useful,
11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13  * GNU General Public License for more details.
14  *
15  * You should have received a copy of the GNU General Public License
16  * along with this program. If not, see <http://www.gnu.org/licenses/>.
17  * 
18  */
19
20 #ifndef __COMPOSE_H__
21 #define __COMPOSE_H__
22
23 typedef struct _Compose         Compose;
24 typedef struct _AttachInfo      AttachInfo;
25
26 #include <glib.h>
27 #include <gtk/gtk.h>
28
29 #include "procmsg.h"
30 #include "procmime.h"
31 #include "prefs_account.h"
32 #include "undo.h"
33 #include "toolbar.h"
34 #include "codeconv.h"
35 #include "template.h"
36 #include "viewtypes.h"
37 #include "folder.h"
38
39 #ifdef USE_ENCHANT
40 #include "gtkaspell.h"
41 #endif
42
43 #define COMPOSE_CHECK_BEFORE_SEND_HOOKLIST "compose_check_before_send"
44 #define COMPOSE_CREATED_HOOKLIST "compose_created"
45
46 typedef enum
47 {
48         COMPOSE_TO,
49         COMPOSE_CC,
50         COMPOSE_BCC,
51         COMPOSE_REPLYTO,
52         COMPOSE_NEWSGROUPS,
53         COMPOSE_FOLLOWUPTO,
54         COMPOSE_INREPLYTO
55 } ComposeEntryType;
56
57 typedef enum
58 {
59         COMPOSE_REPLY,
60         COMPOSE_REPLY_WITH_QUOTE,
61         COMPOSE_REPLY_WITHOUT_QUOTE,
62         COMPOSE_REPLY_TO_SENDER,
63         COMPOSE_REPLY_TO_ADDRESS,
64         COMPOSE_FOLLOWUP_AND_REPLY_TO,
65         COMPOSE_REPLY_TO_SENDER_WITH_QUOTE,
66         COMPOSE_REPLY_TO_SENDER_WITHOUT_QUOTE,
67         COMPOSE_REPLY_TO_ALL,
68         COMPOSE_REPLY_TO_ALL_WITH_QUOTE,
69         COMPOSE_REPLY_TO_ALL_WITHOUT_QUOTE,
70         COMPOSE_REPLY_TO_LIST,
71         COMPOSE_REPLY_TO_LIST_WITH_QUOTE,
72         COMPOSE_REPLY_TO_LIST_WITHOUT_QUOTE,
73         COMPOSE_FORWARD,
74         COMPOSE_FORWARD_AS_ATTACH,
75         COMPOSE_FORWARD_INLINE,
76         COMPOSE_NEW,
77         COMPOSE_REDIRECT,
78         COMPOSE_REEDIT
79 } ComposeMode;
80
81 typedef enum
82 {
83         COMPOSE_QUEUE_SUCCESS = 0,
84         COMPOSE_QUEUE_ERROR_NO_MSG = -1,
85         COMPOSE_QUEUE_ERROR_WITH_ERRNO = -2,
86         COMPOSE_QUEUE_ERROR_SIGNING_FAILED = -3,
87         COMPOSE_QUEUE_ERROR_ENCRYPT_FAILED = -4,
88         COMPOSE_QUEUE_ERROR_CHAR_CONVERSION = -5,
89         COMPOSE_QUEUE_ERROR_NO_ENCRYPTION_KEY = -6,
90         COMPOSE_QUEUE_SIGNING_CANCELLED = -7
91 } ComposeQueueResult;
92
93 typedef enum {
94         PREF_ACCOUNT,
95         PREF_FOLDER,
96         PREF_TEMPLATE,
97         PREF_ML,
98         PREF_MAILTO,
99         PREF_NONE
100 } ComposePrefType;
101
102 typedef struct {
103         guint headernum;
104         Compose *compose;
105         GtkWidget *combo;
106         GtkWidget *entry;
107         GtkWidget *button;
108         GtkWidget *hbox;
109         ComposePrefType type;
110 } ComposeHeaderEntry;
111
112 struct _Compose
113 {
114         /* start with window widget don`t change order */
115         GtkWidget *window;
116         GtkWidget *vbox;
117         GtkWidget *menubar;
118
119         /* Toolbar handlebox */
120         GtkWidget *handlebox;
121         Toolbar *toolbar;
122         
123         GtkWidget *vbox2;
124
125         /* Header */
126         GtkWidget *table_vbox;
127         GtkWidget *table;
128         GtkWidget *account_combo;
129         GtkWidget *subject_entry;
130         GtkWidget *paned;
131
132         /* Attachments */
133         GtkWidget *attach_scrwin;
134         GtkWidget *attach_clist;
135         GtkWidget *attach_label;
136
137         /* Others */
138         GtkWidget *savemsg_checkbtn;
139         GtkWidget *savemsg_combo;
140
141         /* Headers notebook */
142         GtkWidget *notebook;
143
144         /* Textedit */
145         GtkWidget *edit_vbox;
146         GtkWidget *ruler_hbox;
147         GtkWidget *ruler;
148         GtkWidget *scrolledwin;
149         GtkWidget *text;
150         GtkWidget *from_name;
151
152         GtkWidget *focused_editable;
153
154         GtkWidget *popupmenu;
155
156         GtkWidget *tmpl_menu;
157
158         ComposeMode mode;
159
160         MsgInfo *targetinfo;
161         MsgInfo *replyinfo;
162         MsgInfo *autosaved_draft;
163         MsgInfo *fwdinfo;
164
165         GtkWidget *header_table;
166         GSList    *header_list;
167         guint      header_nextrow;
168         ComposeHeaderEntry *header_last;
169
170         GHashTable *email_hashtable;
171
172         gchar   *replyto;
173         gchar   *cc;
174         gchar   *bcc;
175         gchar   *newsgroups;
176         gchar   *followup_to;
177
178         gchar   *ml_post;
179
180         gchar   *inreplyto;
181         gchar   *references;
182         gchar   *msgid;
183         gchar   *boundary;
184
185         gboolean autowrap;
186         gboolean autoindent;
187
188         gboolean use_to;
189         gboolean use_cc;
190         gboolean use_bcc;
191         gboolean use_replyto;
192         gboolean use_newsgroups;
193         gboolean use_followupto;
194         gboolean use_attach;
195
196         CharSet out_encoding;
197
198         /* privacy settings */
199         gboolean use_signing;
200         gboolean use_encryption;
201         gchar *privacy_system;
202         gchar *encdata;
203
204         gboolean modified;
205
206         gboolean sending;
207         
208         gboolean return_receipt;
209
210         gboolean batch;
211         
212         GSList *to_list;
213         GSList *newsgroup_list;
214
215         PrefsAccount *account;
216         FolderItem *folder;
217
218         UndoMain *undostruct;
219
220         gchar *sig_str;
221         gboolean sig_inserted;
222
223         /* external editor */
224         gchar      *exteditor_file;
225         pid_t       exteditor_pid;
226         GIOChannel *exteditor_ch;
227         gint        exteditor_tag;
228         GtkWidget  *exteditor_socket;
229
230         /* Priority */
231         gint priority;
232
233         gchar *redirect_filename;
234         
235         gboolean remove_references;
236
237         gint64 draft_timeout_tag;
238         
239         GtkTextTag *no_wrap_tag;
240         GtkTextTag *no_join_tag;
241         GtkTextTag *signature_tag;
242         GtkTextTag *quote0_tag;
243         GtkTextTag *quote1_tag;
244         GtkTextTag *quote2_tag;
245         GtkTextTag *uri_tag;
246
247         gboolean automatic_break;
248         GMutex *mutex;
249         gint close_timeout_tag;
250         gchar *orig_charset;
251         gint set_cursor_pos;
252
253         gboolean updating;
254         gboolean deferred_destroy;
255         ComposeMode rmode;
256         GtkWidget *first_combo;
257         GtkWidget *first_entry;
258
259         GtkUIManager *ui_manager;
260
261         gint folder_update_callback_id;
262 #if USE_ENCHANT
263         /* GNU/aspell spell checker */
264         GtkAspell *gtkaspell;
265         GtkWidget *aspell_options_menu;
266 #endif
267
268 #ifdef USE_LDAP
269         /* List of addressbook ifaces which we disabled, and will
270          * enable in compose_destroy. */
271         GSList *passworded_ldap_servers;
272 #endif
273 };
274
275 struct _AttachInfo
276 {
277         gchar *file;
278         gchar *content_type;
279         EncodingType encoding;
280         gchar *name;
281         goffset size;
282         gchar *charset;
283         gboolean insert;
284 };
285
286 typedef enum
287 {
288         COMPOSE_QUIT_EDITING,
289         COMPOSE_KEEP_EDITING,
290         COMPOSE_AUTO_SAVE,
291         COMPOSE_DRAFT_FOR_EXIT
292 } ComposeDraftAction;
293
294 /*#warning FIXME_GTK2 */
295 /* attach_files will be locale encode */
296 Compose *compose_new                    (PrefsAccount   *account,
297                                          const gchar    *mailto,
298                                          GList          *attach_files);
299
300 Compose *compose_new_with_folderitem    (PrefsAccount   *account,
301                                          FolderItem     *item,
302                                          const gchar    *mailto);
303
304 Compose *compose_new_with_list          (PrefsAccount   *account,
305                                          GList          *listAddress);
306
307 Compose *compose_forward                (PrefsAccount *account,
308                                          MsgInfo        *msginfo,
309                                          gboolean        as_attach,
310                                          const gchar    *body,
311                                          gboolean        no_extedit,
312                                          gboolean        batch);
313
314 Compose *compose_redirect               (PrefsAccount   *account,
315                                          MsgInfo        *msginfo,
316                                          gboolean        batch);
317 Compose *compose_reedit                 (MsgInfo        *msginfo,
318                                          gboolean        batch);
319
320 const GList *compose_get_compose_list   (void);
321
322 void compose_entry_append               (Compose          *compose,
323                                          const gchar      *address,
324                                          ComposeEntryType  type,
325                                          ComposePrefType   pref_type);
326
327
328 gint compose_send                       (Compose          *compose);
329
330 void compose_update_actions_menu        (Compose        *compose);
331 void compose_reflect_prefs_all                  (void);
332 void compose_reflect_prefs_pixmap_theme (void);
333
334 void compose_destroy_all                (void);
335 gboolean compose_draft                  (gpointer data, guint action);
336 void compose_toolbar_cb                 (gint           action, 
337                                          gpointer       data);
338 void compose_reply_to_address           (MessageView    *msgview,
339                                          MsgInfo        *msginfo,
340                                          const gchar    *address);
341 void compose_reply_from_messageview     (MessageView    *msgview, 
342                                          GSList         *msginfo_list, 
343                                          guint           action);
344 void compose_action_cb                  (void           *data);
345
346 void compose_set_position                               (Compose        *compose,
347                                                  gint            pos);
348 gboolean compose_search_string                  (Compose        *compose,
349                                                  const gchar    *str,
350                                                  gboolean        case_sens);
351 gboolean compose_search_string_backward (Compose        *compose,
352                                                  const gchar    *str,
353                                                  gboolean        case_sens);
354 ComposeQueueResult compose_queue        (Compose *compose,
355                                          gint *msgnum, 
356                                          FolderItem **item, 
357                                          gchar **msgpath,
358                                          gboolean remove_reedit_target);
359 gboolean compose_close                  (Compose *compose);
360 void compose_close_toolbar              (Compose *compose);
361 void compose_clear_exit_drafts          (void);
362 void compose_reopen_exit_drafts         (void);
363 void compose_attach_from_list (Compose *compose, GList *file_list, gboolean free_data);
364 void compose_check_for_email_account(Compose *compose);
365
366 void compose_use_signing(Compose *compose, gboolean use_signing);
367 void compose_use_encryption(Compose *compose, gboolean use_encryption);
368
369 #endif /* __COMPOSE_H__ */