summaryrefslogtreecommitdiff
path: root/src/help.cpp
blob: ccfc9d3102e7c7c87eb12b9b644116c37bd91cab (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
/***************************************************************************
 *   Copyright (C) 2008-2009 by Andrzej Rybczak                            *
 *   electricityispower@gmail.com                                          *
 *                                                                         *
 *   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 "mpdpp.h"

#include "global.h"
#include "help.h"
#include "settings.h"
#include "tag_editor.h"

using namespace Global;

Help *myHelp = new Help;

void Help::Init()
{
	w = new Scrollpad(0, main_start_y, COLS, main_height, "", Config.main_color, brNone);
	w->SetTimeout(ncmpcpp_window_timeout);
	GetKeybindings();
	w->Flush();
}

void Help::Resize()
{
	w->Resize(COLS, main_height);
	hasToBeResized = 0;
}

void Help::SwitchTo()
{
	if (myScreen == this)
		return;
	
	if (hasToBeResized)
		Resize();
	
	myScreen = this;
	redraw_header = 1;

}

std::string Help::Title()
{
	return "Help";
}

std::string Help::DisplayKeys(int *key, int size)
{
	bool backspace = 1;
	std::string result = "\t";
	for (int i = 0; i < size; i++)
	{
		if (key[i] == null_key);
		else if (key[i] == 259)
			result += "Up";
		else if (key[i] == 258)
			result += "Down";
		else if (key[i] == 339)
			result += "Page Up";
		else if (key[i] == 338)
			result += "Page Down";
		else if (key[i] == 262)
			result += "Home";
		else if (key[i] == 360)
			result += "End";
		else if (key[i] == 32)
			result += "Space";
		else if (key[i] == 10)
			result += "Enter";
		else if (key[i] == 330)
			result += "Delete";
		else if (key[i] == 261)
			result += "Right";
		else if (key[i] == 260)
			result += "Left";
		else if (key[i] == 9)
			result += "Tab";
		else if (key[i] >= 1 && key[i] <= 26)
		{
			result += "Ctrl-";
			result += key[i]+64;
		}
		else if (key[i] >= 265 && key[i] <= 276)
		{
			result += "F";
			result += IntoStr(key[i]-264);
		}
		else if ((key[i] == 263 || key[i] == 127) && !backspace);
		else if ((key[i] == 263 || key[i] == 127) && backspace)
		{
			result += "Backspace";
			backspace = 0;
		}
		else
			result += key[i];
		result += " ";
	}
	if (result.length() > 12)
		result = result.substr(0, 12);
	for (size_t i = result.length(); i <= 12; result += " ", i++) { }
	result += ": ";
	return result;
}

void Help::GetKeybindings()
{
	*w << "   " << fmtBold << "Keys - Movement\n -----------------------------------------\n" << fmtBoldEnd;
	*w << DisplayKeys(Key.Up) << "Move Cursor up\n";
	*w << DisplayKeys(Key.Down) << "Move Cursor down\n";
	*w << DisplayKeys(Key.PageUp) << "Page up\n";
	*w << DisplayKeys(Key.PageDown) << "Page down\n";
	*w << DisplayKeys(Key.Home) << "Home\n";
	*w << DisplayKeys(Key.End) << "End\n\n";
	
	*w << DisplayKeys(Key.ScreenSwitcher) << "Switch between playlist and browser\n";
	*w << DisplayKeys(Key.Help) << "Help screen\n";
	*w << DisplayKeys(Key.Playlist) << "Playlist screen\n";
	*w << DisplayKeys(Key.Browser) << "Browse screen\n";
	*w << DisplayKeys(Key.SearchEngine) << "Search engine\n";
	*w << DisplayKeys(Key.MediaLibrary) << "Media library\n";
	*w << DisplayKeys(Key.PlaylistEditor) << "Playlist editor\n";
#	ifdef HAVE_TAGLIB_H
	*w << DisplayKeys(Key.TagEditor) << "Tag editor\n";
#	endif // HAVE_TAGLIB_H
#	ifdef ENABLE_CLOCK
	*w << DisplayKeys(Key.Clock) << "Clock screen\n";
#	endif // ENABLE_CLOCK
	*w << "\n\n";
	
	*w << "   " << fmtBold << "Keys - Global\n -----------------------------------------\n" << fmtBoldEnd;
	*w << DisplayKeys(Key.Stop) << "Stop\n";
	*w << DisplayKeys(Key.Pause) << "Pause\n";
	*w << DisplayKeys(Key.Next) << "Next track\n";
	*w << DisplayKeys(Key.Prev) << "Previous track\n";
	*w << DisplayKeys(Key.SeekForward) << "Seek forward\n";
	*w << DisplayKeys(Key.SeekBackward) << "Seek backward\n";
	*w << DisplayKeys(Key.VolumeDown) << "Decrease volume\n";
	*w << DisplayKeys(Key.VolumeUp) << "Increase volume\n\n";
	
	*w << DisplayKeys(Key.ToggleSpaceMode) << "Toggle space mode (select/add)\n";
	*w << DisplayKeys(Key.ToggleAddMode) << "Toggle add mode\n";
	*w << DisplayKeys(Key.ReverseSelection) << "Reverse selection\n";
	*w << DisplayKeys(Key.DeselectAll) << "Deselect all items\n";
	*w << DisplayKeys(Key.AddSelected) << "Add selected items to playlist/m3u file\n\n";
	
	*w << DisplayKeys(Key.ToggleRepeat) << "Toggle repeat mode\n";
	*w << DisplayKeys(Key.ToggleRepeatOne) << "Toggle \"repeat one\" mode\n";
	*w << DisplayKeys(Key.ToggleRandom) << "Toggle random mode\n";
	*w << DisplayKeys(Key.Shuffle) << "Shuffle playlist\n";
	*w << DisplayKeys(Key.ToggleCrossfade) << "Toggle crossfade mode\n";
	*w << DisplayKeys(Key.SetCrossfade) << "Set crossfade\n";
	*w << DisplayKeys(Key.UpdateDB) << "Start a music database update\n\n";
	
	*w << DisplayKeys(Key.ApplyFilter) << "Apply filter\n";
	*w << DisplayKeys(Key.FindForward) << "Forward find\n";
	*w << DisplayKeys(Key.FindBackward) << "Backward find\n";
	*w << DisplayKeys(Key.PrevFoundPosition) << "Go to previous found position\n";
	*w << DisplayKeys(Key.NextFoundPosition) << "Go to next found position\n";
	*w << DisplayKeys(Key.ToggleFindMode) << "Toggle find mode (normal/wrapped)\n";
	*w << DisplayKeys(Key.GoToContainingDir) << "Locate song in browser\n";
	*w << DisplayKeys(Key.ToggleDisplayMode) << "Toggle display mode\n";
#	ifdef HAVE_TAGLIB_H
	*w << DisplayKeys(Key.EditTags) << "Edit song's tags/playlist's name\n";
#	endif // HAVE_TAGLIB_H
	*w << DisplayKeys(Key.GoToPosition) << "Go to chosen position in current song\n";
	*w << DisplayKeys(Key.SongInfo) << "Show song's info\n";
#	ifdef HAVE_CURL_CURL_H
	*w << DisplayKeys(Key.ArtistInfo) << "Show artist's info\n";
	*w << DisplayKeys(Key.ToggleLyricsDB) << "Toggle lyrics database\n";
#	endif // HAVE_CURL_CURL_H
	*w << DisplayKeys(Key.Lyrics) << "Show/hide song's lyrics\n\n";
	
	*w << DisplayKeys(Key.Quit) << "Quit\n\n\n";
	
	
	*w << "   " << fmtBold << "Keys - Playlist screen\n -----------------------------------------\n" << fmtBoldEnd;
	*w << DisplayKeys(Key.Enter) << "Play\n";
	*w << DisplayKeys(Key.Delete) << "Delete item/selected items from playlist\n";
	*w << DisplayKeys(Key.Clear) << "Clear playlist\n";
	*w << DisplayKeys(Key.Crop) << "Clear playlist but hold currently playing/selected items\n";
	*w << DisplayKeys(Key.MvSongUp) << "Move item/group of items up\n";
	*w << DisplayKeys(Key.MvSongDown) << "Move item/group of items down\n";
	*w << DisplayKeys(Key.Add) << "Add url/file/directory to playlist\n";
	*w << DisplayKeys(Key.SavePlaylist) << "Save playlist\n";
	*w << DisplayKeys(Key.SortPlaylist) << "Sort playlist\n";
	*w << DisplayKeys(Key.GoToNowPlaying) << "Go to currently playing position\n";
	*w << DisplayKeys(Key.StartSearching) << "Toggle \"stop playing after current song\" option\n";
	*w << DisplayKeys(Key.ToggleAutoCenter) << "Toggle auto center mode\n\n\n";
	
	*w << "   " << fmtBold << "Keys - Browse screen\n -----------------------------------------\n" << fmtBoldEnd;
	*w << DisplayKeys(Key.Enter) << "Enter directory/Add item to playlist and play\n";
	*w << DisplayKeys(Key.Space) << "Add item to playlist\n";
	if (Mpd->GetHostname()[0] == '/') // are we connected to unix socket?
		*w << DisplayKeys(Key.SwitchTagTypeList) << "Browse MPD database/local filesystem\n";
	*w << DisplayKeys(Key.GoToNowPlaying) << "Locate currently playing song\n";
	*w << DisplayKeys(Key.GoToParentDir) << "Go to parent directory\n";
	*w << DisplayKeys(Key.Delete) << "Delete playlist\n\n\n";
	
	
	*w << "   " << fmtBold << "Keys - Search engine\n -----------------------------------------\n" << fmtBoldEnd;
	*w << DisplayKeys(Key.Enter) << "Add item to playlist and play/change option\n";
	*w << DisplayKeys(Key.Space) << "Add item to playlist\n";
	*w << DisplayKeys(Key.StartSearching) << "Start searching immediately\n\n\n";
	
	
	*w << "   " << fmtBold << "Keys - Media library\n -----------------------------------------\n" << fmtBoldEnd;
	*w << DisplayKeys(&Key.VolumeDown[0], 1) << "Previous column\n";
	*w << DisplayKeys(&Key.VolumeUp[0], 1) << "Next column\n";
	*w << DisplayKeys(Key.Enter) << "Add to playlist and play song/album/artist's songs\n";
	*w << DisplayKeys(Key.Space) << "Add to playlist song/album/artist's songs\n";
	*w << DisplayKeys(Key.SwitchTagTypeList) << "Tag type list switcher (left column)\n\n\n";
	
	*w << "   " << fmtBold << "Keys - Playlist Editor\n -----------------------------------------\n" << fmtBoldEnd;
	*w << DisplayKeys(&Key.VolumeDown[0], 1) << "Previous column\n";
	*w << DisplayKeys(&Key.VolumeUp[0], 1) << "Next column\n";
	*w << DisplayKeys(Key.Enter) << "Add item to playlist and play\n";
	*w << DisplayKeys(Key.Space) << "Add to playlist/select item\n";
#	ifndef HAVE_TAGLIB_H
	*w << DisplayKeys(Key.EditTags) << "Edit playlist's name\n";
#	endif // ! HAVE_TAGLIB_H
	*w << DisplayKeys(Key.MvSongUp) << "Move item/group of items up\n";
	*w << DisplayKeys(Key.MvSongDown) << "Move item/group of items down\n";
	
	*w << "\n\n   " << fmtBold << "Keys - Lyrics\n -----------------------------------------\n" << fmtBoldEnd;
	*w << DisplayKeys(Key.Space) << "Switch for following lyrics of now playing song\n";
	
#	ifdef HAVE_TAGLIB_H
	*w << "\n\n   " << fmtBold << "Keys - Tag editor\n -----------------------------------------\n" << fmtBoldEnd;
	*w << DisplayKeys(Key.Enter) << "Change tag/filename for one song (left column)\n";
	*w << DisplayKeys(Key.Enter) << "Perform operation on all/selected songs (middle column)\n";
	*w << DisplayKeys(Key.Space) << "Switch to albums/directories view (left column)\n";
	*w << DisplayKeys(Key.Space) << "Select/deselect song (right column)\n";
	*w << DisplayKeys(&Key.VolumeDown[0], 1) << "Previous column\n";
	*w << DisplayKeys(&Key.VolumeUp[0], 1) << "Next column\n";
#	endif // HAVE_TAGLIB_H
}