提交: cd3f096cf3e950eb716945cb852ccb834e7f91b0 - medialist-cli (git)

CLI interface to medialist (fossil mirror)

Commit MetaInfo

• 修订版: cd3f096cf3e950eb716945cb852ccb834e7f91b0 (tree)
• 时间: 2023-03-14 10:15:17
• 作者: mio <stigma@disr...>
• Commiter: mio

Log Message

Add nothrow version of ml_send_command

FossilOrigin-Name: 5d8042cc5ef8fb8df4e39a86b152a293507d05c2f095fcccc84e339668dd336d

更改概述

• modified: medialist.d

差异

--- a/medialist.d
+++ b/medialist.d
@@ -147,14 +147,14 @@ struct MediaListItem
     /// Returns: A string containing the TSV representation of *item*.
     ///
     string tsvRepresentation() const {
-	import std.format : format;
-
-	return "%s\t%s\t%s\t%s\t%s\t%s".format(this.title,
-					       this.progress,
-					       this.status,
-					       this.startDate,
-					       this.endDate,
-					       this.lastUpdated);
+        import std.format : format;
+
+        return "%s\t%s\t%s\t%s\t%s\t%s".format(this.title,
+                                               this.progress,
+                                               this.status,
+                                               this.startDate,
+                                               this.endDate,
+                                               this.lastUpdated);
     }
 }
 
@@ -221,7 +221,9 @@ enum MLCommand
     /// `["(Optional) Item ID", "(Optional) Item ID", ...]`
     ///
     /// If no there are no "Item ID" values in `args`, then the entire
-    /// list is irreversibly deleted.
+    /// list is irreversibly deleted. **NOTE**: This functionality has
+    /// been deprecated from version 0.2.0, it'll be removed in a later
+    /// version.
     ///
     delete_,
     ///
@@ -455,7 +457,7 @@ MediaList* ml_open_list(string filePath, out MLError error) nothrow
 ///
 /// See_Also: ml_open_list
 ///
-void ml_free_list(MediaList* list)
+void ml_free_list(MediaList* list) nothrow
 {
     import core.memory : GC;
 
@@ -1018,7 +1020,7 @@ MediaListItem[] ml_fetch_items(MediaList* list, size_t[] ids ...)
 ///  ml_fetch_item, ml_fetch_all
 ///
 MediaListItem[] ml_fetch_items(MediaList* list, out MLError err,
-			       size_t[] ids ...) nothrow
+                               size_t[] ids ...) nothrow
 {
     import core.stdc.errno : errno, EACCES;
 
@@ -1190,8 +1192,7 @@ MediaListItem[] ml_fetch_all(MediaList* list, out MLError error) nothrow
 ///
 /// This is the main way to interact with a MediaList. The value of
 /// *args* will depend on the value of *command*.  See `MLCommand`
-/// for more information.  If there are any errors in the way *args*
-/// is formatted, `MLError.invalidArgs` will be returned.
+/// for more information.
 ///
 /// Params:
 ///   list = The MediaList to perform the action on.
@@ -1201,33 +1202,68 @@ MediaListItem[] ml_fetch_all(MediaList* list, out MLError error) nothrow
 /// Returns: If no error occurred, then `MLError.success` will be
 ///          returned.  Otherwise, a value of `MLError`.
 ///
+/// Throws: `MLException` if there was an error in the way the *args* were
+///         formatted.
+///
 /// See_Also:
 ///  MLCommand
 ///
-MLError ml_send_command(MediaList* list, MLCommand command, string[] args)
+void ml_send_command(MediaList* list, MLCommand command, string[] args)
 {
-    MLError res;
+    switch (command)
+    {
+    case MLCommand.add:
+        _ml_add(list, args);
+        break;
+    case MLCommand.delete_:
+        _ml_delete(list, args);
+        break;
+    case MLCommand.update:
+        _ml_update(list, args);
+        break;
+    default:
+        throw new MLException(MLError.unknownCommand);
+    }
+}
 
+///
+/// Perform a *command* on *list*.
+///
+/// This is the main way to interact with a MediaList. The value of
+/// *args* will depend on the value of *command*.  See `MLCommand`
+/// for more information.  If there are any errors, *error* will be
+/// set to a value other than `MLError.success`.
+///
+/// Params:
+///   list = The MediaList to perform the action on.
+///   command = The type of action to perform.
+///   args = The arguments that *command* will use.
+///   error = The out-parameter for determining any errrors.
+///
+/// See_Also:
+///  MLCommand
+///
+void ml_send_command(MediaList* list, MLCommand command, string[] args,
+             out MLError error) nothrow
+{
     switch (command)
     {
     case MLCommand.add:
-        res = _ml_add(list, args);
+        _ml_add(list, args, error);
         break;
     case MLCommand.delete_:
-        res = _ml_delete(list, args);
+        _ml_delete(list, args, error);
         break;
     case MLCommand.update:
-        res = _ml_update(list, args);
+        _ml_update(list, args, error);
         break;
     default:
-        res = MLError.unknownCommand;
+        error = MLError.unknownCommand;
         break;
     }
-
-    return res;
 }
 
-private MLError _ml_add(MediaList* list, string[] args)
+private void _ml_add(MediaList* list, string[] args)
 {
     string title;
     string progress = "-/-";
@@ -1236,7 +1272,7 @@ private MLError _ml_add(MediaList* list, string[] args)
     DateTime currentDate = cast(DateTime)Clock.currTime;
 
     if (args.length < 1)
-        return MLError.invalidArgs;
+        throw new MLException(MLError.invalidArgs);
 
     title = args[0];
 
@@ -1247,7 +1283,7 @@ private MLError _ml_add(MediaList* list, string[] args)
         status = (args[2] is null) ? "UNKNOWN" : args[2];
 
     if (true == list.isOpen)
-        return MLError.fileAlreadyOpen;
+        throw new MLException(MLError.fileAlreadyOpen);
 
     size_t[2][6] headerPositions = _ml_get_header_positions(list);
     int currentIndent = 0;
@@ -1275,8 +1311,8 @@ private MLError _ml_add(MediaList* list, string[] args)
             listFile.write(status);
             break;
         case MLHeaders.lastUpdated:
-            listFile.writef("%d-%02d-%02d", currentDate.year, currentDate.month,
-                currentDate.day);
+            listFile.writef("%d-%02d-%02d", currentDate.year,
+                            currentDate.month, currentDate.day);
             break;
         default:
             break;
@@ -1284,8 +1320,25 @@ private MLError _ml_add(MediaList* list, string[] args)
     }
 
     listFile.write("\n");
+}
 
-    return MLError.success;
+private void _ml_add(MediaList* list, string[] args, out MLError error) nothrow
+{
+    import core.stdc.errno : errno, EACCES;
+    
+    error = MLError.success;
+    
+    try {
+        _ml_add(list, args);
+    } catch (MLException e) {
+        error = e.error;
+    } catch (StdioException e) {
+        error = (errno == EACCES) ?
+            MLError.permissionError :
+            MLError.unspecifiedError;
+    } catch (Exception e) {
+        error = MLError.unspecifiedError;
+    }
 }
 
 /**
@@ -1311,21 +1364,21 @@ private size_t[] _ml_conv_sort_num_list(const string[] args)
     return ids;
 }
 
-private MLError _ml_delete(MediaList* list, string[] args)
+private void _ml_delete(MediaList* list, string[] args)
 {
     if (true == list.isOpen)
-        return MLError.fileAlreadyOpen;
+        throw new MLException(MLError.fileAlreadyOpen);
 
     if (0 == args.length) {
-        // TODO: Use system recycle bin (6518ca25e4)
+        // NOTE: This will be removed in a version after 0.2.0.
         remove(list.filePath);
-        return MLError.success;
+        return;
     }
 
     size_t[] ids = _ml_conv_sort_num_list(args);
 
     if (null is ids)
-        return MLError.invalidArgs;
+        throw new MLException(MLError.invalidArgs);
 
     File listFile = File(list.filePath);
     list.isOpen = true;
@@ -1383,17 +1436,34 @@ private MLError _ml_delete(MediaList* list, string[] args)
     tempFile.close();
 
     remove(tempFilePath);
+}
+
+private void _ml_delete(MediaList* list, string[] args, out MLError error) nothrow
+{
+    import core.stdc.errno : errno, EACCES;
 
-    return MLError.success;
+    error = MLError.success;
+
+    try {
+        _ml_delete(list, args);
+    } catch (MLException me) {
+        error = me.error;
+    } catch (StdioException se) {
+        error = (errno == EACCES) ?
+            MLError.permissionError :
+            MLError.unspecifiedError;
+    } catch (Exception e) {
+        error = MLError.unspecifiedError;
+    }
 }
 
-private MLError _ml_update(MediaList* list, string[] args)
+private void _ml_update(MediaList* list, string[] args)
 {
     if (list.isOpen)
-        return MLError.fileAlreadyOpen;
+        throw new MLException(MLError.fileAlreadyOpen);
 
     if (2 > args.length)
-        return MLError.invalidArgs;
+        throw new MLException(MLError.invalidArgs);
 
     string title = null;
     string progress = null;
@@ -1406,7 +1476,7 @@ private MLError _ml_update(MediaList* list, string[] args)
     try {
         id = to!size_t(args[0]);
     } catch (Exception e) {
-        return MLError.invalidArgs;
+        throw new MLException(MLError.invalidArgs);
     }
 
     foreach(string arg; args) {
@@ -1569,8 +1639,23 @@ private MLError _ml_update(MediaList* list, string[] args)
         listFile.write(line);
     }
     listFile.flush();
+}
 
-    return MLError.success;
+private void _ml_update(MediaList* list, string[] args, out MLError error) nothrow
+{
+    error = MLError.success;
+
+    try {
+        _ml_update(list, args);
+    } catch (MLException me) {
+        error = me.error;
+    } catch (StdioException se) {
+        error = (errno == EACCESS) ?
+            MLError.permissionError :
+            MLError.unspecifiedError;
+    } catch (Exception e) {
+        error = MLError.unspecifiedError;
+    }
 }
 
 private enum MLHeaders