ncmpcpp/src/display.cpp

/***************************************************************************
 *   Copyright (C) 2008-2021 by Andrzej Rybczak                            *
 *   andrzej@rybczak.net                                                   *
 *                                                                         *
 *   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.,                                       *
 *   51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA.              *
 ***************************************************************************/

#include <cassert>

#include "curses/menu_impl.h"
#include "screens/browser.h"
#include "charset.h"
#include "display.h"
#include "format_impl.h"
#include "helpers.h"
#include "screens/song_info.h"
#include "screens/playlist.h"
#include "global.h"
#include "screens/tag_editor.h"
#include "utility/string.h"
#include "utility/type_conversions.h"

using Global::myScreen;

namespace {

const wchar_t *toColumnName(char c)
{
	switch (c)
	{
		case 'l':
			return L"Time";
		case 'f':
			return L"Filename";
		case 'D':
			return L"Directory";
		case 'F':
			return L"Filepath";
		case 'a':
			return L"Artist";
		case 'A':
			return L"Album Artist";
		case 't':
			return L"Title";
		case 'b':
			return L"Album";
		case 'y':
			return L"Date";
		case 'n': case 'N':
			return L"Track";
		case 'g':
			return L"Genre";
		case 'c':
			return L"Composer";
		case 'p':
			return L"Performer";
		case 'd':
			return L"Disc";
		case 'C':
			return L"Comment";
		case 'P':
			return L"Priority";
		default:
			return L"?";
	}
}

template <typename T>
void setProperties(NC::Menu<T> &menu, const MPD::Song &s, const SongList &list,
                   bool &separate_albums, bool &is_now_playing, bool &is_selected,
                   bool &is_in_playlist, bool &discard_colors)
{
	size_t drawn_pos = menu.drawn() - menu.begin();
	separate_albums = false;
	if (Config.playlist_separate_albums)
	{
		auto next = list.beginS() + drawn_pos + 1;
		if (next != list.endS())
		{
			if (next->song() != nullptr)
			{
				// Draw a separator when the next album is different than the current
				// one. In case there are two albums with the same name, but a different
				// album artist, compare also album artists.
				separate_albums = next->song()->getAlbum() != s.getAlbum()
				               || next->song()->getAlbumArtist() != s.getAlbumArtist();
			}
		}
	}
	if (separate_albums)
	{
		menu << NC::Format::Underline;
		mvwhline(menu.raw(), menu.getY(), 0, NC::Key::Space, menu.getWidth());
	}

	int song_pos = s.getPosition();
	is_now_playing = Status::State::player() != MPD::psStop
		&& myPlaylist->isActiveWindow(menu)
		&& song_pos == Status::State::currentSongPosition();
	if (is_now_playing)
		menu << Config.now_playing_prefix;

	is_in_playlist = !myPlaylist->isActiveWindow(menu)
		&& myPlaylist->checkForSong(s);
	if (is_in_playlist)
		menu << NC::Format::Bold;

	is_selected = menu.drawn()->isSelected();
	discard_colors = Config.discard_colors_if_item_is_selected && is_selected;
}

template <typename T>
void unsetProperties(NC::Menu<T> &menu, bool separate_albums, bool is_now_playing,
                     bool is_in_playlist)
{
	if (is_in_playlist)
		menu << NC::Format::NoBold;

	if (is_now_playing)
		menu << Config.now_playing_suffix;

	if (separate_albums)
		menu << NC::Format::NoUnderline;
}

template <typename T>
void showSongs(NC::Menu<T> &menu, const MPD::Song &s, const SongList &list, const Format::AST<char> &ast)
{
	bool separate_albums, is_now_playing, is_selected, is_in_playlist, discard_colors;
	setProperties(menu, s, list, separate_albums, is_now_playing, is_selected,
	              is_in_playlist, discard_colors);

	const size_t y = menu.getY();
	NC::Buffer right_aligned;
	Format::print(ast, menu, &s, &right_aligned,
		discard_colors ? Format::Flags::Tag | Format::Flags::OutputSwitch : Format::Flags::All
	);
	if (!right_aligned.str().empty())
	{
		size_t x_off = menu.getWidth() - wideLength(ToWString(right_aligned.str()));
		if (menu.isHighlighted() && list.currentS()->song() == &s)
		{
			if (menu.highlightSuffix() == Config.current_item_suffix)
				x_off -= Config.current_item_suffix_length;
			else
				x_off -= Config.current_item_inactive_column_suffix_length;
		}
		if (is_now_playing)
			x_off -= Config.now_playing_suffix_length;
		if (is_selected)
			x_off -= Config.selected_item_suffix_length;
		menu << NC::TermManip::ClearToEOL << NC::XY(x_off, y) << right_aligned;
	}

	unsetProperties(menu, separate_albums, is_now_playing, is_in_playlist);
}

template <typename T>
void showSongsInColumns(NC::Menu<T> &menu, const MPD::Song &s, const SongList &list)
{
	if (Config.columns.empty())
		return;

	bool separate_albums, is_now_playing, is_selected, is_in_playlist, discard_colors;
	setProperties(menu, s, list, separate_albums, is_now_playing, is_selected,
	              is_in_playlist, discard_colors);

	int menu_width = menu.getWidth();
	if (menu.isHighlighted() && list.currentS()->song() == &s)
	{
		if (menu.highlightPrefix() == Config.current_item_prefix)
			menu_width -= Config.current_item_prefix_length;
		else
			menu_width -= Config.current_item_inactive_column_prefix_length;

		if (menu.highlightSuffix() == Config.current_item_suffix)
			menu_width -= Config.current_item_suffix_length;
		else
			menu_width -= Config.current_item_inactive_column_suffix_length;
	}
	if (is_now_playing)
	{
		menu_width -= Config.now_playing_prefix_length;
		menu_width -= Config.now_playing_suffix_length;
	}
	if (is_selected)
	{
		menu_width -= Config.selected_item_prefix_length;
		menu_width -= Config.selected_item_suffix_length;
	}

	int width;
	int y = menu.getY();
	int remained_width = menu_width;

	std::vector<Column>::const_iterator it, last = Config.columns.end() - 1;
	for (it = Config.columns.begin(); it != Config.columns.end(); ++it)
	{
		// check current X coordinate
		int x = menu.getX();
		// column has relative width and all after it have fixed width,
		// so stretch it so it fills whole screen along with these after.
		if (it->stretch_limit >= 0) // (*)
			width = remained_width - it->stretch_limit;
		else
			width = it->fixed ? it->width : it->width * menu_width * 0.01;
		// columns with relative width may shrink to 0, omit them
		if (width == 0)
			continue;
		// if column is not last, we need to have spacing between it
		// and next column, so we substract it now and restore later.
		if (it != last)
			--width;

		// if column doesn't fit into screen, discard it and any other after it.
		if (remained_width-width < 0 || width < 0 /* this one may come from (*) */)
			break;

		std::wstring tag;
		for (size_t i = 0; i < it->type.length(); ++i)
		{
			MPD::Song::GetFunction get = charToGetFunction(it->type[i]);
			assert(get);
			tag = ToWString(Charset::utf8ToLocale(s.getTags(get)));
			if (!tag.empty())
				break;
		}
		if (tag.empty() && it->display_empty_tag)
			tag = ToWString(Config.empty_tag);
		wideCut(tag, width);

		if (!discard_colors && it->color != NC::Color::Default)
			menu << it->color;

		int x_off = 0;
		// if column uses right alignment, calculate proper offset.
		// otherwise just assume offset is 0, ie. we start from the left.
		if (it->right_alignment)
			x_off = std::max(0, width - int(wideLength(tag)));

		whline(menu.raw(), NC::Key::Space, width);
		menu.goToXY(x + x_off, y);
		menu << tag;
		menu.goToXY(x + width, y);
		if (it != last)
		{
			// add missing width's part and restore the value.
			menu << ' ';
			remained_width -= width+1;
		}

		if (!discard_colors && it->color != NC::Color::Default)
			menu << NC::Color::End;
	}

	unsetProperties(menu, separate_albums, is_now_playing, is_in_playlist);
}

}

std::string Display::Columns(size_t list_width)
{
	std::string result;
	if (Config.columns.empty())
		return result;
	
	int width;
	int remained_width = list_width;
	std::vector<Column>::const_iterator it, last = Config.columns.end() - 1;
	for (it = Config.columns.begin(); it != Config.columns.end(); ++it)
	{
		// column has relative width and all after it have fixed width,
		// so stretch it so it fills whole screen along with these after.
		if (it->stretch_limit >= 0) // (*)
			width = remained_width - it->stretch_limit;
		else
			width = it->fixed ? it->width : it->width * list_width * 0.01;
		// columns with relative width may shrink to 0, omit them
		if (width == 0)
			continue;
		// if column is not last, we need to have spacing between it
		// and next column, so we substract it now and restore later.
		if (it != last)
			--width;
		
		// if column doesn't fit into screen, discard it and any other after it.
		if (remained_width-width < 0 || width < 0 /* this one may come from (*) */)
			break;
		
		std::wstring name;
		if (it->name.empty())
		{
			size_t j = 0;
			while (true)
			{
				name += toColumnName(it->type[j]);
				++j;
				if (j < it->type.length())
					name += '/';
				else
					break;
			}
		}
		else
			name = it->name;
		wideCut(name, width);
		
		int x_off = std::max(0, width - int(wideLength(name)));
		if (it->right_alignment)
		{
			result += std::string(x_off, NC::Key::Space);
			result += Charset::utf8ToLocale(ToString(name));
		}
		else
		{
			result += Charset::utf8ToLocale(ToString(name));
			result += std::string(x_off, NC::Key::Space);
		}
		
		if (it != last)
		{
			// add missing width's part and restore the value.
			remained_width -= width+1;
			result += ' ';
		}
	}
	
	return result;
}

void Display::SongsInColumns(NC::Menu<MPD::Song> &menu, const SongList &list)
{
	showSongsInColumns(menu, menu.drawn()->value(), list);
}

void Display::Songs(NC::Menu<MPD::Song> &menu, const SongList &list, const Format::AST<char> &ast)
{
	showSongs(menu, menu.drawn()->value(), list, ast);
}

#ifdef HAVE_TAGLIB_H
void Display::Tags(NC::Menu<MPD::MutableSong> &menu)
{
	const MPD::MutableSong &s = menu.drawn()->value();
	if (s.isModified())
		menu << Config.modified_item_prefix;
	size_t i = myTagEditor->TagTypes->choice();
	if (i < 11)
	{
		ShowTag(menu, Charset::utf8ToLocale(s.getTags(SongInfo::Tags[i].Get)));
	}
	else if (i == 12)
	{
		if (s.getNewName().empty())
			menu << Charset::utf8ToLocale(s.getName());
		else
			menu << Charset::utf8ToLocale(s.getName())
			     << Config.color2
			     << " -> "
			     << NC::FormattedColor::End<>(Config.color2)
			     << Charset::utf8ToLocale(s.getNewName());
	}
}
#endif // HAVE_TAGLIB_H

void Display::Items(NC::Menu<MPD::Item> &menu, const SongList &list)
{
	const MPD::Item &item = menu.drawn()->value();
	switch (item.type())
	{
		case MPD::Item::Type::Directory:
			menu << "["
			     << Charset::utf8ToLocale(getBasename(item.directory().path()))
			     << "]";
			break;
		case MPD::Item::Type::Song:
			switch (Config.browser_display_mode)
			{
				case DisplayMode::Classic:
					showSongs(menu, item.song(), list, Config.song_list_format);
					break;
				case DisplayMode::Columns:
					showSongsInColumns(menu, item.song(), list);
					break;
			}
			break;
		case MPD::Item::Type::Playlist:
			menu << Config.browser_playlist_prefix
			     << Charset::utf8ToLocale(getBasename(item.playlist().path()));
			break;
	}
}

void Display::SEItems(NC::Menu<SEItem> &menu, const SongList &list)
{
	const SEItem &si = menu.drawn()->value();
	if (si.isSong())
	{
		switch (Config.search_engine_display_mode)
		{
			case DisplayMode::Classic:
				showSongs(menu, si.song(), list, Config.song_list_format);
				break;
			case DisplayMode::Columns:
				showSongsInColumns(menu, si.song(), list);
				break;
		}
	}
	else
		menu << si.buffer();
}