mpd/src/queue/QueueSave.hxx

/*
 * Copyright 2003-2021 The Music Player Daemon Project
 * http://www.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.,
 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 */

/*
 * This library saves the queue into the state file, and also loads it
 * back into memory.
 */

#ifndef MPD_QUEUE_SAVE_HXX
#define MPD_QUEUE_SAVE_HXX

struct Queue;
class BufferedOutputStream;
class TextFile;
class SongLoader;

void
queue_save(BufferedOutputStream &os, const Queue &queue);

/**
 * Loads one song from the state file and appends it to the queue.
 *
 * Throws on error.
 */
void
queue_load_song(TextFile &file, const SongLoader &loader,
		const char *line, Queue &queue);

#endif
playlist: moved saving/loading code to queue_save.c Create a new library which saves/loads the queue to/from the state file. 2009-01-23 16:35:04 +01:00			`/*`
copyright year 2021 2021-01-01 19:54:25 +01:00			`* Copyright 2003-2021 The Music Player Daemon Project`
playlist: moved saving/loading code to queue_save.c Create a new library which saves/loads the queue to/from the state file. 2009-01-23 16:35:04 +01:00			`* http://www.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.`
all: Update copyright header. This updates the copyright header to all be the same, which is pretty much an update of where to mail request for a copy of the GPL and the years of the MPD project. This also puts all committers under 'The Music Player Project' umbrella. These entries should go individually in the AUTHORS file, for consistancy. 2009-03-13 18:43:16 +01:00			`*`
			`* 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.`
playlist: moved saving/loading code to queue_save.c Create a new library which saves/loads the queue to/from the state file. 2009-01-23 16:35:04 +01:00			`*/`

			`/*`
			`* This library saves the queue into the state file, and also loads it`
			`* back into memory.`
			`*/`

db_save, state_file: convert to C++ 2013-01-02 19:52:57 +01:00			`#ifndef MPD_QUEUE_SAVE_HXX`
			`#define MPD_QUEUE_SAVE_HXX`
playlist: moved saving/loading code to queue_save.c Create a new library which saves/loads the queue to/from the state file. 2009-01-23 16:35:04 +01:00
Queue: rename struct queue to Queue Works around a build failure on Solaris because annoyingly, Solaris reserves the name "queue". This rename was pending anyway. 2014-01-20 08:57:22 +01:00			`struct Queue;`
Save, State: use the OutputStream API instead of FILE* 2014-07-30 20:58:14 +02:00			`class BufferedOutputStream;`
TextFile: convert to a class 2013-01-03 10:16:05 +01:00			`class TextFile;`
QueueSave: use class SongLoader 2014-02-03 22:25:54 +01:00			`class SongLoader;`
playlist: moved saving/loading code to queue_save.c Create a new library which saves/loads the queue to/from the state file. 2009-01-23 16:35:04 +01:00
			`void`
Save, State: use the OutputStream API instead of FILE* 2014-07-30 20:58:14 +02:00			`queue_save(BufferedOutputStream &os, const Queue &queue);`
playlist: moved saving/loading code to queue_save.c Create a new library which saves/loads the queue to/from the state file. 2009-01-23 16:35:04 +01:00
			`/**`
queue_save: queue_load_song() returns void The only caller doesn't use its return value, and the value isn't useful anyway. 2010-07-25 12:43:05 +02:00			`* Loads one song from the state file and appends it to the queue.`
queue/Save: queue_load_song() throws on error Don't catch and log exceptions here; let the caller decide. 2019-09-05 20:55:18 +02:00			`*`
			`* Throws on error.`
playlist: moved saving/loading code to queue_save.c Create a new library which saves/loads the queue to/from the state file. 2009-01-23 16:35:04 +01:00			`*/`
queue_save: queue_load_song() returns void The only caller doesn't use its return value, and the value isn't useful anyway. 2010-07-25 12:43:05 +02:00			`void`
QueueSave: use class SongLoader 2014-02-03 22:25:54 +01:00			`queue_load_song(TextFile &file, const SongLoader &loader,`
			`const char *line, Queue &queue);`
playlist: moved saving/loading code to queue_save.c Create a new library which saves/loads the queue to/from the state file. 2009-01-23 16:35:04 +01:00
			`#endif`