Changeset b54b06a

Timestamp:

Sep 30, 2011, 8:14:49 AM (13 years ago)

Author:

Jason Gross <jgross@mit.edu>

Children:

cce9369

Parents:

c0e728a

git-author:

Jason Gross <jgross@mit.edu> (05/23/11 22:03:45)

git-committer:

Jason Gross <jgross@mit.edu> (09/30/11 08:14:49)

Message:

Added functionality for creating enum variables from perl

Files:

• perl/lib/BarnOwl.pm (modified) (5 diffs)
• perlglue.xs (modified) (1 diff)

perl/lib/BarnOwl.pm

@@ -17 +17 @@
                     add_io_dispatch remove_io_dispatch
                     new_command
-                    new_variable_int new_variable_bool new_variable_string
+                    new_variable_int new_variable_bool new_variable_string new_variable_enum
                     quote redisplay);
 our %EXPORT_TAGS = (all => \@EXPORT_OK);
@@ -389 +389 @@
 =head2 new_variable_string NAME [{ARGS}]
 
-Add a new owl variable, either an int, a bool, or a string, with the
-specified name.
+=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:
@@ -398 +400 @@
 =item default
 
-The default and initial value for the variable
+The default and initial value for the variable.
+Note that this should be a string value for an enum.
 
 =item summary
@@ -407 +410 @@
 
 A longer description of the function of the variable
+
+=item valid_settings
+
+A listref of valid setttings for the enum variable.
+The settings must not contain any commas.
 
 =back
@@ -425 +433 @@
     unshift @_, \&BarnOwl::Internal::new_variable_string, "";
     goto \&_new_variable;
+}
+
+sub new_variable_enum {
+    my $name = shift;
+    my $args = shift || {};
+    my %args = (
+        summary     => "",
+        description => "",
+        %{$args});
+
+    my @valid_settings =  @{$args{valid_settings}};
+    if (defined $args{default}) {
+        ($args{default}) = grep { $args{default} eq $valid_settings[$_] } 0..$#valid_settings; # turn the string default into a numerical default
+    } else {
+        $args{default} = 0;
+    }
+    $args{valid_settings} = join ",", @valid_settings;
+
+    BarnOwl::Internal::new_variable_enum($name, $args{default}, $args{summary}, $args{description}, $args{valid_settings});
 }
 

perlglue.xs

@@ -444 +444 @@
 
 void
+new_variable_enum(name, ival, summ, desc, validset)
+        const char * name
+        int ival
+        const char * summ
+        const char * desc
+        const char * validset
+        CODE:
+        owl_variable_dict_newvar_enum(owl_global_get_vardict(&g),
+                                      name,
+                                      summ,
+                                      desc,
+                                      ival,
+                                      validset);
+
+void
 start_edit(edit_type, line, callback)
         const char *edit_type