src/osd.c

   1 /*
   2  * Copyright (C) 2018 The Geeqie Team
   3  *
   4  * Author: Colin Clark
   5  *
   6  * This program is free software; you can redistribute it and/or modify
   7  * it under the terms of the GNU General Public License as published by
   8  * the Free Software Foundation; either version 2 of the License, or
   9  * (at your option) any later version.
  10  *
  11  * This program is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14  * GNU General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU General Public License along
  17  * with this program; if not, write to the Free Software Foundation, Inc.,
  18  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  19  */
  20
  21 /* Routines for creating the Overlay Screen Display text. Also
  22  * used for the same purposes by the Print routines
  23  */
  24
  25 #include "main.h"
  26 #include "osd.h"
  27
  28 #include "dnd.h"
  29 #include "exif.h"
  30 #include "glua.h"
  31 #include "metadata.h"
  32 #include "ui_fileops.h"
  33 #include "ui_misc.h"
  34
  35 #include <math.h>
  36
  37 static const gchar *predefined_tags[][2] = {
  38         {"%name%",                                                      N_("Name")},
  39         {"%path:60%",                                           N_("Path")},
  40         {"%date%",                                                      N_("Date")},
  41         {"%size%",                                                      N_("Size")},
  42         {"%zoom%",                                                      N_("Zoom")},
  43         {"%dimensions%",                                        N_("Dimensions")},
  44         {"%collection%",                                        N_("Collection")},
  45         {"%number%",                                            N_("Image index")},
  46         {"%total%",                                                     N_("Images total")},
  47         {"%comment%",                                           N_("Comment")},
  48         {"%keywords%",                                          N_("Keywords")},
  49         {"%file.ctime%",                                        N_("File ctime")},
  50         {"%file.mode%",                                         N_("File mode")},
  51         {"%file.owner%",                                        N_("File owner")},
  52         {"%file.group%",                                        N_("File group")},
  53         {"%file.link%",                                         N_("File link")},
  54         {"%file.class%",                                        N_("File class")},
  55         {"%file.page_no%",                                      N_("File page no.")},
  56         {"%formatted.DateTime%",                        N_("Image date")},
  57         {"%formatted.DateTimeDigitized%",       N_("Date digitized")},
  58         {"%formatted.ShutterSpeed%",            N_("ShutterSpeed")},
  59         {"%formatted.Aperture%",                        N_("Aperture")},
  60         {"%formatted.ExposureBias%",            N_("Exposure bias")},
  61         {"%formatted.Resolution%",                      N_("Resolution")},
  62         {"%formatted.Camera%",                          N_("Camera")},
  63         {"%lua.lensID%",                                        N_("Lens")},
  64         {"%formatted.ISOSpeedRating%",          N_("ISO")},
  65         {"%formatted.FocalLength%",                     N_("Focal length")},
  66         {"%formatted.FocalLength35mmFilm%",     N_("Focal len. 35mm")},
  67         {"%formatted.SubjectDistance%",         N_("Subject distance")},
  68         {"%formatted.Flash%",                           N_("Flash")},
  69         {"%formatted.ColorProfile%",            N_("Color profile")},
  70         {"%formatted.GPSPosition%",                     N_("Lat, Long")},
  71         {"%formatted.GPSAltitude%",                     N_("Altitude")},
  72         {"%formatted.localtime%",                       N_("Local time")},
  73         {"%formatted.timezone%",                        N_("Timezone")},
  74         {"%formatted.countryname%",                     N_("Country name")},
  75         {"%formatted.countrycode%",                     N_("Country code")},
  76         {"%rating%",                                            N_("Rating")},
  77         {"%formatted.star_rating%",                     N_("Star rating")},
  78         {"%Xmp.dc.creator%",                            N_("© Creator")},
  79         {"%Xmp.dc.contributor%",                        N_("© Contributor")},
  80         {"%Xmp.dc.rights%",                                     N_("© Rights")},
  81         {NULL, NULL}};
  82
  83 static GtkTargetEntry osd_drag_types[] = {
  84         { "text/plain", GTK_TARGET_SAME_APP, TARGET_TEXT_PLAIN }
  85 };
  86
  87 typedef struct _TagData TagData;
  88 struct _TagData
  89 {
  90         gchar *key;
  91         gchar *title;
  92 };
  93
  94 static void tag_button_cb(GtkWidget *widget, gpointer data)
  95 {
  96         GtkTextView *image_overlay_template_view = data;
  97         GtkTextBuffer *buffer;
  98         TagData *td;
  99
 100         buffer = gtk_text_view_get_buffer(image_overlay_template_view);
 101         td = g_object_get_data(G_OBJECT(widget), "tag_data");
 102         gtk_text_buffer_insert_at_cursor(GTK_TEXT_BUFFER(buffer), td->key, -1);
 103
 104         gtk_widget_grab_focus(GTK_WIDGET(image_overlay_template_view));
 105 }
 106
 107 static void osd_dnd_get_cb(GtkWidget *btn, GdkDragContext *context,
 108                                                                 GtkSelectionData *selection_data, guint info,
 109                                                                 guint time, gpointer data)
 110 {
 111         TagData *td;
 112         GtkTextView *image_overlay_template_view = data;
 113
 114         td = g_object_get_data(G_OBJECT(btn), "tag_data");
 115         gtk_selection_data_set_text(selection_data, td->key, -1);
 116
 117         gtk_widget_grab_focus(GTK_WIDGET(image_overlay_template_view));
 118 }
 119
 120 static void osd_btn_destroy_cb(GtkWidget *btn, GdkDragContext *context,
 121                                                                 GtkSelectionData *selection_data, guint info,
 122                                                                 guint time, gpointer data)
 123 {
 124         TagData *td;
 125
 126         td = g_object_get_data(G_OBJECT(btn), "tag_data");
 127         g_free(td->key);
 128         g_free(td->title);
 129 }
 130
 131 static void set_osd_button(GtkTable *table, const gint rows, const gint cols, const gchar *key, const gchar *title, GtkWidget *template_view)
 132 {
 133         GtkWidget *new_button;
 134         TagData *td;
 135
 136         new_button = gtk_button_new_with_label(title);
 137         g_signal_connect(G_OBJECT(new_button), "clicked", G_CALLBACK(tag_button_cb), template_view);
 138         gtk_widget_show(new_button);
 139
 140         td = g_new0(TagData, 1);
 141         td->key = g_strdup(key);
 142         td->title = g_strdup(title);
 143
 144         g_object_set_data(G_OBJECT(new_button), "tag_data", td);
 145
 146         gtk_drag_source_set(new_button, GDK_BUTTON1_MASK, osd_drag_types, 1, GDK_ACTION_COPY);
 147         g_signal_connect(G_OBJECT(new_button), "drag_data_get",
 148                                                         G_CALLBACK(osd_dnd_get_cb), template_view);
 149         g_signal_connect(G_OBJECT(new_button), "destroy",
 150                                                         G_CALLBACK(osd_btn_destroy_cb), new_button);
 151
 152         gtk_table_attach_defaults(table, new_button, cols, cols+1, rows, rows+1);
 153
 154 }
 155
 156 GtkWidget *osd_new(gint max_cols, GtkWidget *template_view)
 157 {
 158         GtkWidget *vbox;
 159         GtkWidget *scrolled;
 160         gint i = 0;
 161         gint rows = 0;
 162         gint max_rows = 0;
 163         gint cols = 0;
 164         gdouble entries;
 165         GtkWidget *viewport;
 166
 167         vbox = gtk_vbox_new(FALSE, 0);
 168
 169         pref_label_new(vbox, _("To include predefined tags in the template, click a button or drag-and-drop"));
 170
 171         scrolled = gtk_scrolled_window_new(NULL, NULL);
 172         gtk_box_pack_start(GTK_BOX(vbox), scrolled, FALSE, FALSE, 0);
 173         gtk_container_set_border_width(GTK_CONTAINER(scrolled), PREF_PAD_BORDER);
 174         gtk_scrolled_window_set_policy(GTK_SCROLLED_WINDOW(scrolled),
 175                                        GTK_POLICY_NEVER, GTK_POLICY_AUTOMATIC);
 176         gtk_widget_show(scrolled);
 177         gtk_widget_set_size_request(scrolled, -1, 140);
 178
 179         viewport = gtk_viewport_new(NULL, NULL);
 180         gtk_viewport_set_shadow_type(GTK_VIEWPORT(viewport), GTK_SHADOW_NONE);
 181         gtk_container_add(GTK_CONTAINER(scrolled), viewport);
 182         gtk_widget_show(viewport);
 183
 184         entries = (sizeof(predefined_tags) / sizeof(predefined_tags[0])) - 1;
 185         max_rows = ceil(entries / max_cols);
 186
 187         GtkTable *table;
 188         table = GTK_TABLE(gtk_table_new(max_rows, max_cols, FALSE));
 189         gtk_container_add(GTK_CONTAINER(viewport), GTK_WIDGET(table));
 190         gtk_widget_show(GTK_WIDGET(table));
 191
 192         for (rows = 0; rows < max_rows; rows++)
 193                 {
 194                 cols = 0;
 195
 196                 while (cols < max_cols && predefined_tags[i][0])
 197                         {
 198                         set_osd_button(table, rows, cols, predefined_tags[i][0], predefined_tags[i][1], template_view);
 199                         i = i + 1;
 200                         cols++;
 201                         }
 202                 }
 203         return vbox;
 204 }
 205 static gchar *keywords_to_string(FileData *fd)
 206 {
 207         GList *keywords;
 208         GString *kwstr = NULL;
 209         gchar *ret = NULL;
 210
 211         g_assert(fd);
 212
 213         keywords = metadata_read_list(fd, KEYWORD_KEY, METADATA_PLAIN);
 214
 215         if (keywords)
 216                 {
 217                 GList *work = keywords;
 218
 219                 while (work)
 220                         {
 221                         gchar *kw = work->data;
 222                         work = work->next;
 223
 224                         if (!kw) continue;
 225                         if (!kwstr)
 226                                 kwstr = g_string_new("");
 227                         else
 228                                 g_string_append(kwstr, ", ");
 229
 230                         g_string_append(kwstr, kw);
 231                         }
 232                 string_list_free(keywords);
 233                 }
 234
 235         if (kwstr)
 236                 {
 237                 ret = kwstr->str;
 238                 g_string_free(kwstr, FALSE);
 239                 }
 240
 241         return ret;
 242 }
 243
 244 gchar *image_osd_mkinfo(const gchar *str, FileData *fd, GHashTable *vars)
 245 {
 246         gchar delim = '%', imp = '|', sep[] = " - ";
 247         gchar *start, *end;
 248         guint pos, prev;
 249         gboolean want_separator = FALSE;
 250         gchar *name, *data;
 251         GString *new;
 252         gchar *ret;
 253
 254         if (!str || !*str) return g_strdup("");
 255
 256         new = g_string_new(str);
 257
 258         prev = -1;
 259
 260         while (TRUE)
 261                 {
 262                 guint limit = 0;
 263                 gchar *trunc = NULL;
 264                 gchar *limpos = NULL;
 265                 gchar *extra = NULL;
 266                 gchar *extrapos = NULL;
 267                 gchar *p;
 268
 269                 start = strchr(new->str + (prev + 1), delim);
 270                 if (!start)
 271                         break;
 272                 end = strchr(start+1, delim);
 273                 if (!end)
 274                         break;
 275
 276                 /* Search for optional modifiers
 277                  * %name:99:extra% -> name = "name", limit=99, extra = "extra"
 278                  */
 279                 for (p = start + 1; p < end; p++)
 280                         {
 281                         if (p[0] == ':')
 282                                 {
 283                                 if (g_ascii_isdigit(p[1]) && !limpos)
 284                                         {
 285                                         limpos = p + 1;
 286                                         if (!trunc) trunc = p;
 287                                         }
 288                                 else
 289                                         {
 290                                         extrapos = p + 1;
 291                                         if (!trunc) trunc = p;
 292                                         break;
 293                                         }
 294                                 }
 295                         }
 296
 297                 if (limpos)
 298                         limit = (guint) atoi(limpos);
 299
 300                 if (extrapos)
 301                         extra = g_strndup(extrapos, end - extrapos);
 302
 303                 name = g_strndup(start+1, (trunc ? trunc : end)-start-1);
 304                 pos = start - new->str;
 305                 data = NULL;
 306
 307                 if (strcmp(name, "keywords") == 0)
 308                         {
 309                         data = keywords_to_string(fd);
 310                         }
 311                 else if (strcmp(name, "comment") == 0)
 312                         {
 313                         data = metadata_read_string(fd, COMMENT_KEY, METADATA_PLAIN);
 314                         }
 315                 else if (strcmp(name, "imagecomment") == 0)
 316                         {
 317                         data = exif_get_image_comment(fd);
 318                         }
 319                 else if (strcmp(name, "rating") == 0)
 320                         {
 321                         data = metadata_read_string(fd, RATING_KEY, METADATA_PLAIN);
 322                         }
 323 #ifdef HAVE_LUA
 324                 else if (strncmp(name, "lua/", 4) == 0)
 325                         {
 326                         gchar *tmp;
 327                         tmp = strchr(name+4, '/');
 328                         if (!tmp)
 329                                 break;
 330                         *tmp = '\0';
 331                         data = lua_callvalue(fd, name+4, tmp+1);
 332                         }
 333 #endif
 334                 else
 335                         {
 336                         data = g_strdup(g_hash_table_lookup(vars, name));
 337                         if (!data)
 338                                 data = metadata_read_string(fd, name, METADATA_FORMATTED);
 339                         }
 340
 341                 if (data && *data && limit > 0 && strlen(data) > limit + 3)
 342                         {
 343                         gchar *new_data = g_strdup_printf("%-*.*s...", limit, limit, data);
 344                         g_free(data);
 345                         data = new_data;
 346                         }
 347
 348                 if (data)
 349                         {
 350                         /* Since we use pango markup to display, we need to escape here */
 351                         gchar *escaped = g_markup_escape_text(data, -1);
 352                         g_free(data);
 353                         data = escaped;
 354                         }
 355
 356                 if (extra)
 357                         {
 358                         if (data && *data)
 359                                 {
 360                                 /* Display data between left and right parts of extra string
 361                                  * the data is expressed by a '*' character. A '*' may be escaped
 362                                  * by a \. You should escape all '*' characters, do not rely on the
 363                                  * current implementation which only replaces the first unescaped '*'.
 364                                  * If no "*" is present, the extra string is just appended to data string.
 365                                  * Pango mark up is accepted in left and right parts.
 366                                  * Any \n is replaced by a newline
 367                                  * Examples:
 368                                  * "<i>*</i>\n" -> data is displayed in italics ended with a newline
 369                                  * "\n"         -> ended with newline
 370                                  * "ISO *"      -> prefix data with "ISO " (ie. "ISO 100")
 371                                  * "\**\*"      -> prefix data with a star, and append a star (ie. "*100*")
 372                                  * "\\*"        -> prefix data with an anti slash (ie "\100")
 373                                  * "Collection <b>*</b>\n" -> display data in bold prefixed by "Collection " and a newline is appended
 374                                  */
 375                                 /** @FIXME using background / foreground colors lead to weird results.
 376                                  */
 377                                 gchar *new_data;
 378                                 gchar *left = NULL;
 379                                 gchar *right = extra;
 380                                 gchar *p;
 381                                 guint len = strlen(extra);
 382
 383                                 /* Search for left and right parts and unescape characters */
 384                                 for (p = extra; *p; p++, len--)
 385                                         if (p[0] == '\\')
 386                                                 {
 387                                                 if (p[1] == 'n')
 388                                                         {
 389                                                         memmove(p+1, p+2, --len);
 390                                                         p[0] = '\n';
 391                                                         }
 392                                                 else if (p[1] != '\0')
 393                                                         memmove(p, p+1, len--); // includes \0
 394                                                 }
 395                                         else if (p[0] == '*' && !left)
 396                                                 {
 397                                                 right = p + 1;
 398                                                 left = extra;
 399                                                 }
 400
 401                                 if (left) right[-1] = '\0';
 402
 403                                 new_data = g_strdup_printf("%s%s%s", left ? left : "", data, right);
 404                                 g_free(data);
 405                                 data = new_data;
 406                                 }
 407                         g_free(extra);
 408                         }
 409
 410                 g_string_erase(new, pos, end-start+1);
 411                 if (data && *data)
 412                         {
 413                         if (want_separator)
 414                                 {
 415                                 /* insert separator */
 416                                 g_string_insert(new, pos, sep);
 417                                 pos += strlen(sep);
 418                                 want_separator = FALSE;
 419                                 }
 420
 421                         g_string_insert(new, pos, data);
 422                         pos += strlen(data);
 423                 }
 424
 425                 if (pos-prev >= 1 && new->str[pos] == imp)
 426                         {
 427                         /* pipe character is replaced by a separator, delete it
 428                          * and raise a flag if needed */
 429                         g_string_erase(new, pos--, 1);
 430                         want_separator |= (data && *data);
 431                         }
 432
 433                 if (new->str[pos] == '\n') want_separator = FALSE;
 434
 435                 prev = pos - 1;
 436
 437                 g_free(name);
 438                 g_free(data);
 439                 }
 440
 441         /* search and destroy empty lines */
 442         end = new->str;
 443         while ((start = strchr(end, '\n')))
 444                 {
 445                 end = start;
 446                 while (*++(end) == '\n')
 447                         ;
 448                 g_string_erase(new, start-new->str, end-start-1);
 449                 }
 450
 451         g_strchomp(new->str);
 452
 453         ret = new->str;
 454         g_string_free(new, FALSE);
 455
 456         return ret;
 457 }
 458
 459 void osd_template_insert(GHashTable *vars, gchar *keyword, gchar *value, OsdTemplateFlags flags)
 460 {
 461         if (!value)
 462                 {
 463                 g_hash_table_insert(vars, keyword, g_strdup(""));
 464                 return;
 465                 }
 466
 467         if (flags & OSDT_NO_DUP)
 468                 {
 469                 g_hash_table_insert(vars, keyword, value);
 470                 return;
 471                 }
 472         else
 473                 {
 474                 g_hash_table_insert(vars, keyword, g_strdup(value));
 475                 }
 476
 477         if (flags & OSDT_FREE) g_free((gpointer) value);
 478 }
 479 /* vim: set shiftwidth=8 softtabstop=0 cindent cinoptions={1s: */