From a898ed4877454b851c6c805a8ceeca970e91870d Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Fr=C3=A9d=C3=A9ric=20Mangano?= <fmang@mg0.fr>
Date: Sun, 17 Jan 2021 15:50:13 +0100
Subject: [PATCH] Finalize the migration for using exceptions

---
 src/cli.cc     |  2 +-
 src/opustags.h | 23 +++++------------------
 2 files changed, 6 insertions(+), 19 deletions(-)

diff --git a/src/cli.cc b/src/cli.cc
index 012f86b..26418cf 100644
--- a/src/cli.cc
+++ b/src/cli.cc
@@ -338,7 +338,7 @@ static void edit_tags_interactively(ot::opus_tags& tags, const std::optional<std
 		tags.comments = ot::read_comments(tags_file.get(), raw);
 	} catch (const ot::status& rc) {
 		fprintf(stderr, "warning: Leaving %s on the disk.\n", tags_path.c_str());
-		throw rc;
+		throw;
 	}
 	tags_file.reset();
 
diff --git a/src/opustags.h b/src/opustags.h
index 43a54c8..7b6c793 100644
--- a/src/opustags.h
+++ b/src/opustags.h
@@ -45,10 +45,6 @@ namespace ot {
  * Possible return status code, ranging from errors to special statuses. They are usually
  * accompanied with a message with the #status structure.
  *
- * Functions that return non-ok status codes to signal special conditions like #end_of_stream should
- * have it explictly mentionned in their documentation. By default, a non-ok status should be
- * handled like an error.
- *
  * Error codes do not need to be ultra specific, and are mainly used to report special conditions to
  * the caller function. Ultimately, only the error message in the #status is shown to the user.
  *
@@ -83,14 +79,10 @@ enum class st {
 
 /**
  * Wraps a status code with an optional message. It is implictly converted to and from a
- * #status_code.
+ * #status_code. It may be thrown on error by any of the ot:: functions.
  *
  * All the statuses except #st::ok should be accompanied with a relevant error message, in case it
  * propagates back to the main function and is shown to the user.
- *
- * \todo Instead of being returned, it could be thrown. Most of the error handling code just let the
- *       status bubble. When we're confident about RAII, we're good to go. When we migrate, let's
- *       start from main and adapt the functions top-down.
  */
 struct status {
 	status(st code = st::ok) : code(code) {}
@@ -213,12 +205,8 @@ bool is_opus_stream(const ogg_page& identification_header);
 /**
  * Ogg reader, combining a FILE input, an ogg_sync_state reading the pages.
  *
- * Call #read_page repeatedly until #status::end_of_stream to consume the stream, and use #page to
- * check its content.
- *
- * \todo This class could be made more intuitive if it acted like an iterator, to be used like
- *       `for (ogg_page& page : ogg_reader(input))`, but the prerequisite for this is the ability to
- *       throw an exception on error.
+ * Call #read_page repeatedly until it returns false to consume the stream, and use #page to check
+ * its content.
  */
 struct ogg_reader {
 	/**
@@ -234,9 +222,8 @@ struct ogg_reader {
 	 */
 	~ogg_reader() { ogg_sync_clear(&sync); }
 	/**
-	 * Read the next page from the input file. The result, provided the status is #status::ok,
-	 * is made available in the #page field, is owned by the Ogg reader, and is valid until the
-	 * next call to #read_page.
+	 * Read the next page from the input file. The result is made available in the #page field,
+	 * is owned by the Ogg reader, and is valid until the next call to #read_page.
 	 *
 	 * Return true if a page was read, false on end of stream.
 	 */