Changeset e26abb6

Timestamp:

Feb 23, 2013, 5:44:21 PM (11 years ago)

Author:

David Benjamin <davidben@mit.edu>

Branches:

master, release-1.10

Children:

bbc31e4

Parents:

523146b

git-author:

David Benjamin <davidben@mit.edu> (02/16/13 15:43:20)

git-committer:

David Benjamin <davidben@mit.edu> (02/23/13 17:44:21)

Message:

Add new_variable_enum

This seems to work. Yay.

File:

• perl/lib/BarnOwl.pm (modified) (3 diffs)

perl/lib/BarnOwl.pm

@@ -18 +18 @@
                     new_command
                     new_variable_int new_variable_bool new_variable_string
+                    new_variable_enum
                     quote redisplay);
 our %EXPORT_TAGS = (all => \@EXPORT_OK);
@@ -402 +403 @@
 =head2 new_variable_string NAME [{ARGS}]
 
-Add a new owl variable, either an int, a bool, or a string, with the
+=head2 new_variable_enum NAME [{ARGS}]
+
+Add a new owl variable, either an int, a bool, a string, or an enum with the
 specified name.
 
-ARGS can optionally contain the following keys:
+For new_variable_enum, ARGS is required to contain a validsettings key pointing
+to an array reference. For all four, it can optionally contain the following
+keys:
 
 =over 4
@@ -469 +474 @@
             validsettings => "<string>",
             takes_on_off => 0,
+        });
+}
+
+sub new_variable_enum {
+    my ($name, $args) = @_;
+
+    # Gather the valid settings.
+    die "validsettings is required" unless defined($args->{validsettings});
+    my %valid;
+    map { $valid{$_} = 1 } @{$args->{validsettings}};
+
+    my $storage = (defined($args->{default}) ?
+                   $args->{default} :
+                   $args->{validsettings}->[0]);
+    BarnOwl::new_variable_full($name, {
+            %{$args},
+            get_tostring => sub { $storage },
+            set_fromstring => sub {
+                return -1 unless $valid{$_[0]};
+                $storage = $_[0];
+                return 0;
+            },
+            validsettings => join(",", @{$args->{validsettings}})
         });
 }