Code

screen_lyrics: some cleanup
[ncmpc.git] / src / screen_lyrics.c
index 8c2eedc7dd69e64de949a96a50f9d1f0d17cdcab..152b38d30dd28311a010222c2ab21be0dd2097ef 100644 (file)
@@ -1,59 +1,60 @@
-/*
- * (c) 2006 by Kalle Wallin <kaw@linux.se>
- * Copyright (C) 2008 Max Kellermann <max@duempel.org>
- *
+/* ncmpc (Ncurses MPD Client)
+ * (c) 2004-2010 The Music Player Daemon Project
+ * Project homepage: http://musicpd.org
  * This program is free software; you can redistribute it and/or modify
  * it under the terms of the GNU General Public License as published by
  * the Free Software Foundation; either version 2 of the License, or
  * (at your option) any later version.
- *
+
  * This program 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 General Public License for more details.
- * You should have received a copy of the GNU General Public License
- * along with this program; if not, write to the Free Software
- * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
- *
- */
 
-#include <sys/stat.h>
+ * You should have received a copy of the GNU General Public License along
+ * with this program; if not, write to the Free Software Foundation, Inc.,
+ * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
+*/
+
+#include "screen_lyrics.h"
+#include "screen_interface.h"
+#include "screen_message.h"
+#include "screen_file.h"
+#include "screen_song.h"
 #include "i18n.h"
 #include "options.h"
 #include "mpdclient.h"
-#include "command.h"
 #include "screen.h"
-#include "screen_utils.h"
-#include "strfsong.h"
 #include "lyrics.h"
-#include "charset.h"
+#include "screen_text.h"
 
-#define _GNU_SOURCE
+#include <assert.h>
+#include <sys/stat.h>
 #include <stdlib.h>
 #include <string.h>
 #include <glib.h>
 #include <unistd.h>
 #include <stdio.h>
 
-static list_window_t *lw = NULL;
+static struct screen_text text;
 
-static const struct mpd_song *next_song;
+static struct mpd_song *next_song;
+static bool follow = false;
 
 static struct {
        struct mpd_song *song;
 
        char *artist, *title;
 
-       struct lyrics_loader *loader;
-
-       GPtrArray *lines;
+       struct plugin_cycle *loader;
 } current;
 
 static void
 screen_lyrics_abort(void)
 {
        if (current.loader != NULL) {
-               lyrics_free(current.loader);
+               plugin_stop(current.loader);
                current.loader = NULL;
        }
 
@@ -68,35 +69,11 @@ screen_lyrics_abort(void)
        }
 
        if (current.song != NULL) {
-               mpd_freeSong(current.song);
+               mpd_song_free(current.song);
                current.song = NULL;
        }
 }
 
-static void
-screen_lyrics_clear(void)
-{
-       guint i;
-
-       for (i = 0; i < current.lines->len; ++i)
-               g_free(g_ptr_array_index(current.lines, i));
-
-       g_ptr_array_set_size(current.lines, 0);
-}
-
-static void
-lyrics_paint(void);
-
-/**
- * Repaint and update the screen.
- */
-static void
-lyrics_repaint(void)
-{
-       lyrics_paint();
-       wrefresh(lw->w);
-}
-
 /**
  * Repaint and update the screen, if it is currently active.
  */
@@ -104,49 +81,82 @@ static void
 lyrics_repaint_if_active(void)
 {
        if (screen_is_visible(&screen_lyrics)) {
-               lyrics_repaint();
+               screen_text_repaint(&text);
 
                /* XXX repaint the screen title */
        }
 }
 
 static void
-screen_lyrics_set(const GString *str)
+path_lyr_file(char *path, size_t size,
+               const char *artist, const char *title)
 {
-       const char *p, *eol, *next;
+       snprintf(path, size, "%s/.lyrics/%s - %s.txt",
+                       getenv("HOME"), artist, title);
+}
+
+static bool
+exists_lyr_file(const char *artist, const char *title)
+{
+       char path[1024];
+       struct stat result;
+
+       path_lyr_file(path, 1024, artist, title);
 
-       screen_lyrics_clear();
+       return (stat(path, &result) == 0);
+}
 
-       p = str->str;
-       while ((eol = strchr(p, '\n')) != NULL) {
-               char *line;
+static FILE *
+create_lyr_file(const char *artist, const char *title)
+{
+       char path[1024];
 
-               next = eol + 1;
+       snprintf(path, 1024, "%s/.lyrics",
+                getenv("HOME"));
+       mkdir(path, S_IRWXU);
 
-               /* strip whitespace at end */
+       path_lyr_file(path, 1024, artist, title);
 
-               while (eol > p && (unsigned char)eol[-1] <= 0x20)
-                       --eol;
+       return fopen(path, "w");
+}
 
-               /* create copy and append it to current.lines*/
+static int
+store_lyr_hd(void)
+{
+       FILE *lyr_file;
+       unsigned i;
 
-               line = g_malloc(eol - p + 1);
-               memcpy(line, p, eol - p);
-               line[eol - p] = 0;
+       lyr_file = create_lyr_file(current.artist, current.title);
+       if (lyr_file == NULL)
+               return -1;
 
-               g_ptr_array_add(current.lines, line);
+       for (i = 0; i < text.lines->len; ++i)
+               fprintf(lyr_file, "%s\n",
+                       (const char*)g_ptr_array_index(text.lines, i));
 
-               /* reset control characters */
+       fclose(lyr_file);
+       return 0;
+}
 
-               for (eol = line + (eol - p); line < eol; ++line)
-                       if ((unsigned char)*line < 0x20)
-                               *line = ' ';
+static int
+delete_lyr_hd(void)
+{
+       char path[1024];
 
-               p = next;
-       }
+       if (!exists_lyr_file(current.artist, current.title))
+               return -1;
+
+       path_lyr_file(path, 1024, current.artist, current.title);
+       if (unlink(path) != 0)
+               return -2;
 
-       if (*p != 0)
-               g_ptr_array_add(current.lines, g_strdup(p));
+       return 0;
+}
+
+static void
+screen_lyrics_set(const GString *str)
+{
+       screen_text_set(&text, str);
 
        /* paint new data */
 
@@ -154,141 +164,111 @@ screen_lyrics_set(const GString *str)
 }
 
 static void
-screen_lyrics_callback(const GString *result, G_GNUC_UNUSED void *data)
+screen_lyrics_callback(const GString *result, const bool success,
+                      G_GNUC_UNUSED void *data)
 {
        assert(current.loader != NULL);
 
+       /* Display result, which may be lyrics or error messages */
        if (result != NULL)
                screen_lyrics_set(result);
-       else
+
+       if (success == true) {
+               if (options.lyrics_autosave &&
+                   !exists_lyr_file(current.artist, current.title))
+                       store_lyr_hd();
+       } else {
+               /* translators: no lyrics were found for the song */
                screen_status_message (_("No lyrics"));
+       }
 
-       lyrics_free(current.loader);
+       plugin_stop(current.loader);
        current.loader = NULL;
 }
 
 static void
 screen_lyrics_load(const struct mpd_song *song)
 {
-       char buffer[MAX_SONGNAME_LENGTH];
+       const char *artist, *title;
 
        assert(song != NULL);
 
        screen_lyrics_abort();
-       screen_lyrics_clear();
+       screen_text_clear(&text);
 
-       current.song = mpd_songDup(song);
+       artist = mpd_song_get_tag(song, MPD_TAG_ARTIST, 0);
+       title = mpd_song_get_tag(song, MPD_TAG_TITLE, 0);
 
-       strfsong(buffer, sizeof(buffer), "%artist%", song);
-       current.artist = g_strdup(buffer);
-
-       strfsong(buffer, sizeof(buffer), "%title%", song);
-       current.title = g_strdup(buffer);
+       current.song = mpd_song_dup(song);
+       current.artist = g_strdup(artist);
+       current.title = g_strdup(title);
 
        current.loader = lyrics_load(current.artist, current.title,
                                     screen_lyrics_callback, NULL);
 }
 
-static FILE *create_lyr_file(const char *artist, const char *title)
-{
-       char path[1024];
-
-       snprintf(path, 1024, "%s/.lyrics",
-                getenv("HOME"));
-       mkdir(path, S_IRWXU);
-
-       snprintf(path, 1024, "%s/.lyrics/%s - %s.txt",
-                getenv("HOME"), artist, title);
-
-       return fopen(path, "w");
-}
-
-static int store_lyr_hd(void)
-{
-       FILE *lyr_file;
-       unsigned i;
-
-       lyr_file = create_lyr_file(current.artist, current.title);
-       if (lyr_file == NULL)
-               return -1;
-
-       for (i = 0; i < current.lines->len; ++i)
-               fprintf(lyr_file, "%s\n",
-                       (const char*)g_ptr_array_index(current.lines, i));
-
-       fclose(lyr_file);
-       return 0;
-}
-
-static const char *
-list_callback(unsigned idx, G_GNUC_UNUSED int *highlight,
-             G_GNUC_UNUSED void *data)
-{
-       static char buffer[256];
-       char *value;
-
-       if (idx >= current.lines->len)
-               return NULL;
-
-       value = utf8_to_locale(g_ptr_array_index(current.lines, idx));
-       g_strlcpy(buffer, value, sizeof(buffer));
-       free(value);
-
-       return buffer;
-}
-
-
 static void
 lyrics_screen_init(WINDOW *w, int cols, int rows)
 {
-       current.lines = g_ptr_array_new();
-       lw = list_window_init(w, cols, rows);
-       lw->flags = LW_HIDE_CURSOR;
+       screen_text_init(&text, w, cols, rows);
 }
 
 static void
 lyrics_resize(int cols, int rows)
 {
-       lw->cols = cols;
-       lw->rows = rows;
+       screen_text_resize(&text, cols, rows);
 }
 
 static void
 lyrics_exit(void)
 {
-       list_window_free(lw);
-
        screen_lyrics_abort();
-       screen_lyrics_clear();
 
-       g_ptr_array_free(current.lines, TRUE);
-       current.lines = NULL;
+       screen_text_deinit(&text);
 }
 
 static void
-lyrics_open(mpdclient_t *c)
+lyrics_open(struct mpdclient *c)
 {
-       if (next_song == NULL)
-               next_song = c->song;
+       const struct mpd_song *next_song_c =
+               next_song != NULL ? next_song : c->song;
 
-       if (next_song != NULL &&
+       if (next_song_c != NULL &&
            (current.song == NULL ||
-            strcmp(next_song->file, current.song->file) != 0))
-               screen_lyrics_load(next_song);
+            strcmp(mpd_song_get_uri(next_song_c),
+                   mpd_song_get_uri(current.song)) != 0))
+               screen_lyrics_load(next_song_c);
 
+       if (next_song != NULL)
+               mpd_song_free(next_song);
        next_song = NULL;
 }
 
+static void
+lyrics_update(struct mpdclient *c)
+{
+       if (!follow)
+               return;
+
+       if (c->song != NULL &&
+           (current.song == NULL ||
+            strcmp(mpd_song_get_uri(c->song),
+                   mpd_song_get_uri(current.song)) != 0))
+               screen_lyrics_load(c->song);
+}
 
 static const char *
 lyrics_title(char *str, size_t size)
 {
        if (current.loader != NULL) {
                snprintf(str, size, "%s (%s)",
-                        _("Lyrics"), _("loading..."));
+                        _("Lyrics"),
+                        /* translators: this message is displayed
+                           while data is retrieved */
+                        _("loading..."));
                return str;
        } else if (current.artist != NULL && current.title != NULL &&
-                  current.lines->len > 0) {
+                  !screen_text_is_empty(&text)) {
                snprintf(str, size, "%s: %s - %s",
                         _("Lyrics"),
                         current.artist, current.title);
@@ -300,38 +280,50 @@ lyrics_title(char *str, size_t size)
 static void
 lyrics_paint(void)
 {
-       list_window_paint(lw, list_callback, NULL);
+       screen_text_paint(&text);
 }
 
 static bool
-lyrics_cmd(mpdclient_t *c, command_t cmd)
+lyrics_cmd(struct mpdclient *c, command_t cmd)
 {
-       if (list_window_scroll_cmd(lw, current.lines->len, cmd)) {
-               lyrics_repaint();
+       if (screen_text_cmd(&text, c, cmd))
                return true;
-       }
 
        switch(cmd) {
        case CMD_INTERRUPT:
                if (current.loader != NULL) {
                        screen_lyrics_abort();
-                       screen_lyrics_clear();
+                       screen_text_clear(&text);
                }
                return true;
-       case CMD_ADD:
+       case CMD_SAVE_PLAYLIST:
                if (current.loader == NULL && current.artist != NULL &&
                    current.title != NULL && store_lyr_hd() == 0)
-                       screen_status_message (_("Lyrics saved!"));
+                       /* lyrics for the song were saved on hard disk */
+                       screen_status_message (_("Lyrics saved"));
+               return true;
+       case CMD_DELETE:
+               if (current.loader == NULL && current.artist != NULL &&
+                   current.title != NULL) {
+                       switch (delete_lyr_hd()) {
+                       case 0:
+                               screen_status_message (_("Lyrics deleted"));
+                               break;
+                       case -1:
+                               screen_status_message (_("No saved lyrics"));
+                               break;
+                       }
+               }
                return true;
        case CMD_LYRICS_UPDATE:
                if (c->song != NULL) {
                        screen_lyrics_load(c->song);
-                       lyrics_repaint();
+                       screen_text_repaint(&text);
                }
                return true;
 
 #ifdef ENABLE_SONG_SCREEN
-       case CMD_VIEW:
+       case CMD_SCREEN_SONG:
                if (current.song != NULL) {
                        screen_song_switch(c, current.song);
                        return true;
@@ -339,6 +331,9 @@ lyrics_cmd(mpdclient_t *c, command_t cmd)
 
                break;
 #endif
+       case CMD_SCREEN_SWAP:
+               screen_swap(c, current.song);
+               return true;
 
        case CMD_LOCATE:
                if (current.song != NULL) {
@@ -352,15 +347,6 @@ lyrics_cmd(mpdclient_t *c, command_t cmd)
                break;
        }
 
-       lw->selected = lw->start+lw->rows;
-       if (screen_find(lw, current.lines->len,
-                       cmd, list_callback, NULL)) {
-               /* center the row */
-               list_window_center(lw, current.lines->len, lw->selected);
-               lyrics_repaint();
-               return true;
-       }
-
        return false;
 }
 
@@ -368,6 +354,7 @@ const struct screen_functions screen_lyrics = {
        .init = lyrics_screen_init,
        .exit = lyrics_exit,
        .open = lyrics_open,
+       .update = lyrics_update,
        .close = NULL,
        .resize = lyrics_resize,
        .paint = lyrics_paint,
@@ -376,10 +363,11 @@ const struct screen_functions screen_lyrics = {
 };
 
 void
-screen_lyrics_switch(struct mpdclient *c, const struct mpd_song *song)
+screen_lyrics_switch(struct mpdclient *c, const struct mpd_song *song, bool f)
 {
        assert(song != NULL);
 
-       next_song = song;
+       follow = f;
+       next_song = mpd_song_dup(song);
        screen_switch(&screen_lyrics, c);
 }