Trim trailing white spaces.
[geeqie.git] / src / bar_comment.c
1 /*
2  * Geeqie
3  * (C) 2004 John Ellis
4  * Copyright (C) 2008 - 2012 The Geeqie Team
5  *
6  * Author: John Ellis
7  *
8  * This software is released under the GNU General Public License (GNU GPL).
9  * Please read the included file COPYING for more information.
10  * This software comes with no warranty of any kind, use at your own risk!
11  */
12
13
14 #include "main.h"
15 #include "bar_comment.h"
16
17 #include "bar.h"
18 #include "metadata.h"
19 #include "filedata.h"
20 #include "ui_menu.h"
21 #include "ui_misc.h"
22 #include "rcfile.h"
23 #include "layout.h"
24
25 static void bar_pane_comment_changed(GtkTextBuffer *buffer, gpointer data);
26
27 /*
28  *-------------------------------------------------------------------
29  * keyword / comment utils
30  *-------------------------------------------------------------------
31  */
32
33
34
35 typedef struct _PaneCommentData PaneCommentData;
36 struct _PaneCommentData
37 {
38         PaneData pane;
39         GtkWidget *widget;
40         GtkWidget *comment_view;
41         FileData *fd;
42         gchar *key;
43         gint height;
44 };
45
46
47 static void bar_pane_comment_write(PaneCommentData *pcd)
48 {
49         gchar *comment;
50
51         if (!pcd->fd) return;
52
53         comment = text_widget_text_pull(pcd->comment_view);
54
55         metadata_write_string(pcd->fd, pcd->key, comment);
56         g_free(comment);
57 }
58
59
60 static void bar_pane_comment_update(PaneCommentData *pcd)
61 {
62         gchar *comment = NULL;
63         gchar *orig_comment = NULL;
64         gchar *comment_not_null;
65         GtkTextBuffer *comment_buffer = gtk_text_view_get_buffer(GTK_TEXT_VIEW(pcd->comment_view));
66
67         orig_comment = text_widget_text_pull(pcd->comment_view);
68         comment = metadata_read_string(pcd->fd, pcd->key, METADATA_PLAIN);
69         comment_not_null = (comment) ? comment : "";
70         
71         if (strcmp(orig_comment, comment_not_null) != 0)
72                 {
73                 g_signal_handlers_block_by_func(comment_buffer, bar_pane_comment_changed, pcd);
74                 gtk_text_buffer_set_text(comment_buffer, comment_not_null, -1);
75                 g_signal_handlers_unblock_by_func(comment_buffer, bar_pane_comment_changed, pcd);
76                 }
77         g_free(comment);
78         g_free(orig_comment);
79
80         gtk_widget_set_sensitive(pcd->comment_view, (pcd->fd != NULL));
81 }
82
83 static void bar_pane_comment_set_selection(PaneCommentData *pcd, gboolean append)
84 {
85         GList *list = NULL;
86         GList *work;
87         gchar *comment = NULL;
88
89         comment = text_widget_text_pull(pcd->comment_view);
90
91         list = layout_selection_list(pcd->pane.lw);
92         list = file_data_process_groups_in_selection(list, FALSE, NULL);
93         
94         work = list;
95         while (work)
96                 {
97                 FileData *fd = work->data;
98                 work = work->next;
99                 if (fd == pcd->fd) continue;
100
101                 if (append)
102                         {
103                         metadata_append_string(fd, pcd->key, comment);
104                         }
105                 else
106                         {
107                         metadata_write_string(fd, pcd->key, comment);
108                         }
109                 }
110
111         filelist_free(list);
112         g_free(comment);
113 }
114
115 static void bar_pane_comment_sel_add_cb(GtkWidget *button, gpointer data)
116 {
117         PaneCommentData *pcd = data;
118
119         bar_pane_comment_set_selection(pcd, TRUE);
120 }
121
122 static void bar_pane_comment_sel_replace_cb(GtkWidget *button, gpointer data)
123 {
124         PaneCommentData *pcd = data;
125
126         bar_pane_comment_set_selection(pcd, FALSE);
127 }
128
129
130 static void bar_pane_comment_set_fd(GtkWidget *bar, FileData *fd)
131 {
132         PaneCommentData *pcd;
133
134         pcd = g_object_get_data(G_OBJECT(bar), "pane_data");
135         if (!pcd) return;
136
137         file_data_unref(pcd->fd);
138         pcd->fd = file_data_ref(fd);
139
140         bar_pane_comment_update(pcd);
141 }
142
143 static gint bar_pane_comment_event(GtkWidget *bar, GdkEvent *event)
144 {
145         PaneCommentData *pcd;
146
147         pcd = g_object_get_data(G_OBJECT(bar), "pane_data");
148         if (!pcd) return FALSE;
149
150         if (gtk_widget_has_focus(pcd->comment_view)) return gtk_widget_event(pcd->comment_view, event);
151
152         return FALSE;
153 }
154
155 static void bar_pane_comment_write_config(GtkWidget *pane, GString *outstr, gint indent)
156 {
157         PaneCommentData *pcd;
158
159         pcd = g_object_get_data(G_OBJECT(pane), "pane_data");
160         if (!pcd) return;
161
162         WRITE_NL(); WRITE_STRING("<pane_comment ");
163         write_char_option(outstr, indent, "id", pcd->pane.id);
164         write_char_option(outstr, indent, "title", gtk_label_get_text(GTK_LABEL(pcd->pane.title)));
165         WRITE_BOOL(pcd->pane, expanded);
166         WRITE_CHAR(*pcd, key);
167         WRITE_INT(*pcd, height);
168         WRITE_STRING("/>");
169 }
170
171 static void bar_pane_comment_notify_cb(FileData *fd, NotifyType type, gpointer data)
172 {
173         PaneCommentData *pcd = data;
174         if ((type & (NOTIFY_REREAD | NOTIFY_CHANGE | NOTIFY_METADATA)) && fd == pcd->fd)
175                 {
176                 DEBUG_1("Notify pane_comment: %s %04x", fd->path, type);
177
178                 bar_pane_comment_update(pcd);
179                 }
180 }
181
182 static void bar_pane_comment_changed(GtkTextBuffer *buffer, gpointer data)
183 {
184         PaneCommentData *pcd = data;
185
186         bar_pane_comment_write(pcd);
187 }
188
189
190 static void bar_pane_comment_populate_popup(GtkTextView *textview, GtkMenu *menu, gpointer data)
191 {
192         PaneCommentData *pcd = data;
193
194         menu_item_add_divider(GTK_WIDGET(menu));
195         menu_item_add_stock(GTK_WIDGET(menu), _("Add text to selected files"), GTK_STOCK_ADD, G_CALLBACK(bar_pane_comment_sel_add_cb), pcd);
196         menu_item_add_stock(GTK_WIDGET(menu), _("Replace existing text in selected files"), GTK_STOCK_CONVERT, G_CALLBACK(bar_pane_comment_sel_replace_cb), data);
197 }
198
199 static void bar_pane_comment_destroy(GtkWidget *widget, gpointer data)
200 {
201         PaneCommentData *pcd = data;
202
203         file_data_unregister_notify_func(bar_pane_comment_notify_cb, pcd);
204
205         file_data_unref(pcd->fd);
206         g_free(pcd->key);
207
208         g_free(pcd->pane.id);
209
210         g_free(pcd);
211 }
212
213
214 static GtkWidget *bar_pane_comment_new(const gchar *id, const gchar *title, const gchar *key, gboolean expanded, gint height)
215 {
216         PaneCommentData *pcd;
217         GtkWidget *scrolled;
218         GtkTextBuffer *buffer;
219
220         pcd = g_new0(PaneCommentData, 1);
221         
222         pcd->pane.pane_set_fd = bar_pane_comment_set_fd;
223         pcd->pane.pane_event = bar_pane_comment_event;
224         pcd->pane.pane_write_config = bar_pane_comment_write_config;
225         pcd->pane.title = bar_pane_expander_title(title);
226         pcd->pane.id = g_strdup(id);
227         pcd->pane.type = PANE_COMMENT;
228
229         pcd->pane.expanded = expanded;
230         
231         pcd->key = g_strdup(key);
232         pcd->height = height;
233
234         scrolled = gtk_scrolled_window_new(NULL, NULL);
235         
236         pcd->widget = scrolled;
237         g_object_set_data(G_OBJECT(pcd->widget), "pane_data", pcd);
238         g_signal_connect(G_OBJECT(pcd->widget), "destroy",
239                          G_CALLBACK(bar_pane_comment_destroy), pcd);
240         
241         gtk_scrolled_window_set_shadow_type(GTK_SCROLLED_WINDOW(scrolled), GTK_SHADOW_IN);
242         gtk_scrolled_window_set_policy(GTK_SCROLLED_WINDOW(scrolled),
243                                        GTK_POLICY_AUTOMATIC, GTK_POLICY_AUTOMATIC);
244
245         gtk_widget_set_size_request(pcd->widget, -1, height);
246         gtk_widget_show(scrolled);
247
248         pcd->comment_view = gtk_text_view_new();
249         gtk_text_view_set_wrap_mode(GTK_TEXT_VIEW(pcd->comment_view), GTK_WRAP_WORD);
250         gtk_container_add(GTK_CONTAINER(scrolled), pcd->comment_view);
251         g_signal_connect(G_OBJECT(pcd->comment_view), "populate-popup",
252                          G_CALLBACK(bar_pane_comment_populate_popup), pcd);
253         gtk_widget_show(pcd->comment_view);
254
255         buffer = gtk_text_view_get_buffer(GTK_TEXT_VIEW(pcd->comment_view));
256         g_signal_connect(G_OBJECT(buffer), "changed",
257                          G_CALLBACK(bar_pane_comment_changed), pcd);
258
259
260         file_data_register_notify_func(bar_pane_comment_notify_cb, pcd, NOTIFY_PRIORITY_LOW);
261
262         return pcd->widget;
263 }
264
265 GtkWidget *bar_pane_comment_new_from_config(const gchar **attribute_names, const gchar **attribute_values)
266 {
267         gchar *title = NULL;
268         gchar *key = g_strdup(COMMENT_KEY);
269         gboolean expanded = TRUE;
270         gint height = 50;
271         gchar *id = g_strdup("comment");
272         GtkWidget *ret;
273
274         while (*attribute_names)
275                 {
276                 const gchar *option = *attribute_names++;
277                 const gchar *value = *attribute_values++;
278
279                 if (READ_CHAR_FULL("title", title)) continue;
280                 if (READ_CHAR_FULL("key", key)) continue;
281                 if (READ_BOOL_FULL("expanded", expanded)) continue;
282                 if (READ_INT_FULL("height", height)) continue;
283                 if (READ_CHAR_FULL("id", id)) continue;
284                 
285
286                 log_printf("unknown attribute %s = %s\n", option, value);
287                 }
288         
289         bar_pane_translate_title(PANE_COMMENT, id, &title);
290         ret = bar_pane_comment_new(id, title, key, expanded, height);
291         g_free(title);
292         g_free(key);
293         g_free(id);
294         return ret;
295 }
296
297 void bar_pane_comment_update_from_config(GtkWidget *pane, const gchar **attribute_names, const gchar **attribute_values)
298 {
299         PaneCommentData *pcd;
300
301         pcd = g_object_get_data(G_OBJECT(pane), "pane_data");
302         if (!pcd) return;
303
304         gchar *title = NULL;
305
306         while (*attribute_names)
307                 {
308                 const gchar *option = *attribute_names++;
309                 const gchar *value = *attribute_values++;
310
311                 if (READ_CHAR_FULL("title", title)) continue;
312                 if (READ_CHAR_FULL("key", pcd->key)) continue;
313                 if (READ_BOOL_FULL("expanded", pcd->pane.expanded)) continue;
314                 if (READ_INT_FULL("height", pcd->height)) continue;
315                 if (READ_CHAR_FULL("id", pcd->pane.id)) continue;
316                 
317
318                 log_printf("unknown attribute %s = %s\n", option, value);
319                 }
320
321         if (title)
322                 {
323                 bar_pane_translate_title(PANE_COMMENT, pcd->pane.id, &title);
324                 gtk_label_set_text(GTK_LABEL(pcd->pane.title), title);
325                 g_free(title);
326                 }
327         gtk_widget_set_size_request(pcd->widget, -1, pcd->height);
328         bar_update_expander(pane);
329         bar_pane_comment_update(pcd);
330 }
331
332 /* vim: set shiftwidth=8 softtabstop=0 cindent cinoptions={1s: */