From b1725639a21a8661c8e8dfe30811b650abf028b0 Mon Sep 17 00:00:00 2001
From: Robin Krahl <robin.krahl@ireas.org>
Date: Tue, 7 Jan 2020 11:51:11 +0000
Subject: Refactor the Enum! macro into Enum! and Command!

For an easier transition to structopt, this patch splits the two cases
of the Enum! macro into two separate macros (that internally both call
the new enum_int! macro).
---
 nitrocli/src/arg_util.rs | 30 ++++++++++++++++++++++++------
 nitrocli/src/args.rs     | 16 ++++++++--------
 2 files changed, 32 insertions(+), 14 deletions(-)

diff --git a/nitrocli/src/arg_util.rs b/nitrocli/src/arg_util.rs
index e2e7b1d..3e4ba85 100644
--- a/nitrocli/src/arg_util.rs
+++ b/nitrocli/src/arg_util.rs
@@ -24,13 +24,16 @@ macro_rules! count {
   }
 }
 
-/// A macro for generating an enum with a set of simple (i.e., no
-/// parameters) variants and their textual representations.
-// TODO: Right now we hard code the derives we create. We may want to
-//       make this set configurable.
-macro_rules! Enum {
+macro_rules! Command {
   ( $name:ident, [ $( $var:ident => ($str:expr, $exec:expr), ) *] ) => {
-    Enum! {$name, [
+    #[derive(Debug, PartialEq)]
+    pub enum $name {
+      $(
+        $var,
+      )*
+    }
+
+    enum_int! {$name, [
       $( $var => $str, )*
     ]}
 
@@ -49,6 +52,13 @@ macro_rules! Enum {
       }
     }
   };
+}
+
+/// A macro for generating an enum with a set of simple (i.e., no
+/// parameters) variants and their textual representations.
+// TODO: Right now we hard code the derives we create. We may want to
+//       make this set configurable.
+macro_rules! Enum {
   ( $name:ident, [ $( $var:ident => $str:expr, ) *] ) => {
     #[derive(Clone, Copy, Debug, PartialEq)]
     pub enum $name {
@@ -57,6 +67,14 @@ macro_rules! Enum {
       )*
     }
 
+    enum_int! {$name, [
+      $( $var => $str, )*
+    ]}
+  };
+}
+
+macro_rules! enum_int {
+  ( $name:ident, [ $( $var:ident => $str:expr, ) *] ) => {
     impl $name {
       #[allow(unused)]
       pub fn all(&self) -> [$name; count!($($var),*) ] {
diff --git a/nitrocli/src/args.rs b/nitrocli/src/args.rs
index 9f4cae2..0562016 100644
--- a/nitrocli/src/args.rs
+++ b/nitrocli/src/args.rs
@@ -128,7 +128,7 @@ impl From<DeviceModel> for nitrokey::Model {
 
 /// A top-level command for nitrocli.
 #[allow(unused_doc_comments)]
-Enum! {Command, [
+Command! {Command, [
   Config => ("config", config),
   Encrypted => ("encrypted", encrypted),
   Hidden => ("hidden", hidden),
@@ -141,7 +141,7 @@ Enum! {Command, [
   Unencrypted => ("unencrypted", unencrypted),
 ]}
 
-Enum! {ConfigCommand, [
+Command! {ConfigCommand, [
   Get => ("get", config_get),
   Set => ("set", config_set),
 ]}
@@ -181,7 +181,7 @@ impl<T> ConfigOption<T> {
   }
 }
 
-Enum! {OtpCommand, [
+Command! {OtpCommand, [
   Clear => ("clear", otp_clear),
   Get => ("get", otp_get),
   Set => ("set", otp_set),
@@ -213,13 +213,13 @@ Enum! {OtpSecretFormat, [
   Hex => "hex",
 ]}
 
-Enum! {PinCommand, [
+Command! {PinCommand, [
   Clear => ("clear", pin_clear),
   Set => ("set", pin_set),
   Unblock => ("unblock", pin_unblock),
 ]}
 
-Enum! {PwsCommand, [
+Command! {PwsCommand, [
   Clear => ("clear", pws_clear),
   Get => ("get", pws_get),
   Set => ("set", pws_set),
@@ -257,7 +257,7 @@ fn reset(ctx: &mut ExecCtx<'_>, args: Vec<String>) -> Result<()> {
   commands::reset(ctx)
 }
 
-Enum! {UnencryptedCommand, [
+Command! {UnencryptedCommand, [
   Set => ("set", unencrypted_set),
 ]}
 
@@ -314,7 +314,7 @@ fn unencrypted_set(ctx: &mut ExecCtx<'_>, args: Vec<String>) -> Result<()> {
   commands::unencrypted_set(ctx, mode)
 }
 
-Enum! {EncryptedCommand, [
+Command! {EncryptedCommand, [
   Close => ("close", encrypted_close),
   Open => ("open", encrypted_open),
 ]}
@@ -364,7 +364,7 @@ fn encrypted_close(ctx: &mut ExecCtx<'_>, args: Vec<String>) -> Result<()> {
   commands::encrypted_close(ctx)
 }
 
-Enum! {HiddenCommand, [
+Command! {HiddenCommand, [
   Close => ("close", hidden_close),
   Create => ("create", hidden_create),
   Open => ("open", hidden_open),
-- 
cgit v1.2.1