Refactored configuration handling.

Slic3r::Config is now an object. Multiple partial config objects are used throughout the codebase as local repositories, then merged and serialized when necessary.

1 files changed, 87 insertions, 92 deletions

diff --git a/slic3r.pl b/slic3r.pl
index 54f72c406..0cf9fab0f 100755
--- a/slic3r.pl
+++ b/slic3r.pl
@@ -30,66 +30,59 @@ my %cli_options = ();
         'export-svg'            => \$opt{export_svg},
         'merge|m'               => \$opt{merge},
     );
-    foreach my $opt_key (keys %$Slic3r::Config::Options) {
-        my $opt = $Slic3r::Config::Options->{$opt_key};
-        my $cli = $opt->{cli} or next;
-        if ($cli =~ /-/) {
-            # allow alternative options with '_' in place of '-'
-            $cli = $opt_key.'|'.$cli;
-        }
-        $options{ $cli } = \$cli_options{$opt_key};
+    foreach my $opt_key (keys %{$Slic3r::Config::Options}) {
+        my $cli = $Slic3r::Config::Options->{$opt_key}->{cli} or next;
+        # allow both the dash-separated option name and the full opt_key
+        $options{ "$opt_key|$cli" } = \$cli_options{$opt_key};
     }
     
     GetOptions(%options) or usage(1);
 }
 
-# load configuration
+# process command line options
+my $cli_config = Slic3r::Config->new_from_cli(%cli_options);
+
+# load configuration files
+my @external_configs = ();
 if ($opt{load}) {
     foreach my $configfile (@{$opt{load}}) {
         if (-e $configfile) {
-            Slic3r::Config->load($configfile);
+            push @external_configs, Slic3r::Config->load($configfile);
         } elsif (-e "$FindBin::Bin/$configfile") {
             printf STDERR "Loading $FindBin::Bin/$configfile\n";
-            Slic3r::Config->load("$FindBin::Bin/$configfile");
+            push @external_configs, Slic3r::Config->load("$FindBin::Bin/$configfile");
         } else {
             $opt{ignore_nonexistent_config} or die "Cannot find specified configuration file ($configfile).\n";
         }
     }
 }
 
-# validate command line options
-delete $cli_options{$_} for grep !defined $cli_options{$_}, keys %cli_options;
-Slic3r::Config->validate_cli(\%cli_options);
+# merge configuration
+my $config = Slic3r::Config->new_from_defaults;
+$config->apply($_) for @external_configs, $cli_config;
+
+# save configuration
+if ($opt{save}) {
+    $config->validate;
+    $config->save($opt{save});
+}
 
-# initialize GUI
+# launch GUI
 my $gui;
 if (!@ARGV && !$opt{save} && eval "require Slic3r::GUI; 1") {
     $gui = Slic3r::GUI->new;
-    $gui->{skeinpanel}->load_config($opt{load}[0]) if $opt{load};
-}
-die $@ if $@ && $opt{gui};
-
-# apply command line options
-Slic3r::Config->set($_ => $cli_options{$_}) for keys %cli_options;
-
-# validate configuration, convert options like --print-center to arrayrefs, init extruders etc.
-# ignore errors if we're launching the GUI
-eval { Slic3r::Config->validate };
-die $@ if $@ && !$gui;
-
-# save configuration
-Slic3r::Config->save($opt{save}) if $opt{save};
-
-# apply command line options to GUI as well and start it
-if ($gui) {
-    $gui->{skeinpanel}->set_value($_, $cli_options{$_}) for keys %cli_options;
+    $gui->{skeinpanel}->load_config_file($opt{load}[0]) if $opt{load};
+    $gui->{skeinpanel}->load_config($cli_config);
     $gui->MainLoop;
     exit;
 }
+die $@ if $@ && $opt{gui};
 
-if (@ARGV) {
+if (@ARGV) {  # slicing from command line
+    $config->validate;
+    
     while (my $input_file = shift @ARGV) {
-        my $print = Slic3r::Print->new;
+        my $print = Slic3r::Print->new(config => $config);
         $print->add_object_from_file($input_file);
         if ($opt{merge}) {
             $print->add_object_from_file($_) for splice @ARGV, 0;
@@ -117,10 +110,12 @@ if (@ARGV) {
 sub usage {
     my ($exit_code) = @_;
     
+    my $config = Slic3r::Config->new_from_defaults;
+    
     my $j = '';
     if ($Slic3r::have_threads) {
         $j = <<"EOF";
-    -j, --threads <num> Number of threads to use (1+, default: $Slic3r::threads)
+    -j, --threads <num> Number of threads to use (1+, default: $config->{threads})
 EOF
     }
     
@@ -143,7 +138,7 @@ $j
     --output-filename-format
                         Output file name format; all config options enclosed in brackets
                         will be replaced by their values, as well as [input_filename_base]
-                        and [input_filename] (default: $Slic3r::output_filename_format)
+                        and [input_filename] (default: $config->{output_filename_format})
     --post-process      Generated G-code will be processed with the supplied script;
                         call this more than once to process through multiple scripts.
     --export-svg        Export a SVG file containing slices instead of G-code.
@@ -151,13 +146,13 @@ $j
                         print rather than processed individually.
   
   Printer options:
-    --nozzle-diameter   Diameter of nozzle in mm (default: @$Slic3r::nozzle_diameter)
+    --nozzle-diameter   Diameter of nozzle in mm (default: $config->{nozzle_diameter}->[0])
     --print-center      Coordinates in mm of the point to center the print around 
-                        (default: $Slic3r::print_center->[0],$Slic3r::print_center->[1])
+                        (default: $config->{print_center}->[0],$config->{print_center}->[1])
     --z-offset          Additional height in mm to add to vertical coordinates
-                        (+/-, default: $Slic3r::z_offset)
+                        (+/-, default: $config->{z_offset})
     --gcode-flavor      The type of G-code to generate (reprap/teacup/makerbot/mach3/no-extrusion,
-                        default: $Slic3r::gcode_flavor)
+                        default: $config->{gcode_flavor})
     --use-relative-e-distances Enable this to get relative E values
     --gcode-arcs        Use G2/G3 commands for native arcs (experimental, not supported
                         by all firmwares)
@@ -166,50 +161,50 @@ $j
     --gcode-comments    Make G-code verbose by adding comments (default: no)
     
   Filament options:
-    --filament-diameter Diameter in mm of your raw filament (default: @$Slic3r::filament_diameter)
+    --filament-diameter Diameter in mm of your raw filament (default: $config->{filament_diameter}->[0])
     --extrusion-multiplier
                         Change this to alter the amount of plastic extruded. There should be
                         very little need to change this value, which is only useful to 
-                        compensate for filament packing (default: @$Slic3r::extrusion_multiplier)
-    --temperature       Extrusion temperature in degree Celsius, set 0 to disable (default: @$Slic3r::temperature)
+                        compensate for filament packing (default: $config->{extrusion_multiplier}->[0])
+    --temperature       Extrusion temperature in degree Celsius, set 0 to disable (default: $config->{temperature}->[0])
     --first-layer-temperature Extrusion temperature for the first layer, in degree Celsius,
                         set 0 to disable (default: same as --temperature)
-    --bed-temperature   Heated bed temperature in degree Celsius, set 0 to disable (default: @$Slic3r::temperature)
+    --bed-temperature   Heated bed temperature in degree Celsius, set 0 to disable (default: $config->{bed_temperature})
     --first-layer-bed-temperature Heated bed temperature for the first layer, in degree Celsius,
                         set 0 to disable (default: same as --bed-temperature)
     
   Speed options:
-    --travel-speed      Speed of non-print moves in mm/s (default: $Slic3r::travel_speed)
-    --perimeter-speed   Speed of print moves for perimeters in mm/s (default: $Slic3r::perimeter_speed)
+    --travel-speed      Speed of non-print moves in mm/s (default: $config->{travel_speed})
+    --perimeter-speed   Speed of print moves for perimeters in mm/s (default: $config->{perimeter_speed})
     --small-perimeter-speed
                         Speed of print moves for small perimeters in mm/s or % over perimeter speed
-                        (default: $Slic3r::small_perimeter_speed)
+                        (default: $config->{small_perimeter_speed})
     --external-perimeter-speed
                         Speed of print moves for the external perimeter in mm/s or % over perimeter speed
-                        (default: $Slic3r::external_perimeter_speed)
-    --infill-speed      Speed of print moves in mm/s (default: $Slic3r::infill_speed)
+                        (default: $config->{external_perimeter_speed})
+    --infill-speed      Speed of print moves in mm/s (default: $config->{infill_speed})
     --solid-infill-speed Speed of print moves for solid surfaces in mm/s or % over infill speed
-                        (default: $Slic3r::solid_infill_speed)
+                        (default: $config->{solid_infill_speed})
     --top-solid-infill-speed Speed of print moves for top surfaces in mm/s or % over solid infill speed
-                        (default: $Slic3r::top_solid_infill_speed)
-    --bridge-speed      Speed of bridge print moves in mm/s (default: $Slic3r::bridge_speed)
+                        (default: $config->{top_solid_infill_speed})
+    --bridge-speed      Speed of bridge print moves in mm/s (default: $config->{bridge_speed})
     --first-layer-speed Speed of print moves for bottom layer, expressed either as an absolute
-                        value or as a percentage over normal speeds (default: $Slic3r::first_layer_speed)
+                        value or as a percentage over normal speeds (default: $config->{first_layer_speed})
     
   Accuracy options:
-    --layer-height      Layer height in mm (default: $Slic3r::layer_height)
-    --first-layer-height Layer height for first layer (mm or %, default: $Slic3r::first_layer_height)
+    --layer-height      Layer height in mm (default: $config->{layer_height})
+    --first-layer-height Layer height for first layer (mm or %, default: $config->{first_layer_height})
     --infill-every-layers
-                        Infill every N layers (default: $Slic3r::infill_every_layers)
+                        Infill every N layers (default: $config->{infill_every_layers})
   
   Print options:
-    --perimeters        Number of perimeters/horizontal skins (range: 0+, default: $Slic3r::perimeters)
+    --perimeters        Number of perimeters/horizontal skins (range: 0+, default: $config->{perimeters})
     --solid-layers      Number of solid layers to do for top/bottom surfaces
-                        (range: 1+, default: $Slic3r::solid_layers)
-    --fill-density      Infill density (range: 0-1, default: $Slic3r::fill_density)
-    --fill-angle        Infill angle in degrees (range: 0-90, default: $Slic3r::fill_angle)
-    --fill-pattern      Pattern to use to fill non-solid layers (default: $Slic3r::fill_pattern)
-    --solid-fill-pattern Pattern to use to fill solid layers (default: $Slic3r::solid_fill_pattern)
+                        (range: 1+, default: $config->{solid_layers})
+    --fill-density      Infill density (range: 0-1, default: $config->{fill_density})
+    --fill-angle        Infill angle in degrees (range: 0-90, default: $config->{fill_angle})
+    --fill-pattern      Pattern to use to fill non-solid layers (default: $config->{fill_pattern})
+    --solid-fill-pattern Pattern to use to fill solid layers (default: $config->{solid_fill_pattern})
     --start-gcode       Load initial G-code from the supplied file. This will overwrite
                         the default command (home all axes [G28]).
     --end-gcode         Load final G-code from the supplied file. This will overwrite 
@@ -222,62 +217,62 @@ $j
    Support material options:
     --support-material  Generate support material for overhangs
     --support-material-threshold
-                        Overhang threshold angle (range: 0-90, default: $Slic3r::support_material_threshold)
+                        Overhang threshold angle (range: 0-90, default: $config->{support_material_threshold})
     --support-material-pattern
-                        Pattern to use for support material (default: $Slic3r::support_material_pattern)
+                        Pattern to use for support material (default: $config->{support_material_pattern})
     --support-material-spacing
-                        Spacing between pattern lines (mm, default: $Slic3r::support_material_spacing)
+                        Spacing between pattern lines (mm, default: $config->{support_material_spacing})
     --support-material-angle
-                        Support material angle in degrees (range: 0-90, default: $Slic3r::support_material_angle)
+                        Support material angle in degrees (range: 0-90, default: $config->{support_material_angle})
   
    Retraction options:
     --retract-length    Length of retraction in mm when pausing extrusion 
-                        (default: $Slic3r::retract_length)
-    --retract-speed     Speed for retraction in mm/s (default: $Slic3r::retract_speed)
+                        (default: $config->{retract_length})
+    --retract-speed     Speed for retraction in mm/s (default: $config->{retract_speed})
     --retract-restart-extra
                         Additional amount of filament in mm to push after
-                        compensating retraction (default: $Slic3r::retract_restart_extra)
+                        compensating retraction (default: $config->{retract_restart_extra})
     --retract-before-travel
-                        Only retract before travel moves of this length in mm (default: $Slic3r::retract_before_travel)
-    --retract-lift      Lift Z by the given distance in mm when retracting (default: $Slic3r::retract_lift)
+                        Only retract before travel moves of this length in mm (default: $config->{retract_before_travel})
+    --retract-lift      Lift Z by the given distance in mm when retracting (default: $config->{retract_lift})
    
    Cooling options:
     --cooling           Enable fan and cooling control
-    --min-fan-speed     Minimum fan speed (default: $Slic3r::min_fan_speed%)
-    --max-fan-speed     Maximum fan speed (default: $Slic3r::max_fan_speed%)
-    --bridge-fan-speed  Fan speed to use when bridging (default: $Slic3r::bridge_fan_speed%)
+    --min-fan-speed     Minimum fan speed (default: $config->{min_fan_speed}%)
+    --max-fan-speed     Maximum fan speed (default: $config->{max_fan_speed}%)
+    --bridge-fan-speed  Fan speed to use when bridging (default: $config->{bridge_fan_speed}%)
     --fan-below-layer-time Enable fan if layer print time is below this approximate number 
-                        of seconds (default: $Slic3r::fan_below_layer_time)
+                        of seconds (default: $config->{fan_below_layer_time})
     --slowdown-below-layer-time Slow down if layer print time is below this approximate number
-                        of seconds (default: $Slic3r::slowdown_below_layer_time)
-    --min-print-speed   Minimum print speed (mm/s, default: $Slic3r::min_print_speed)
-    --disable-fan-first-layers Disable fan for the first N layers (default: $Slic3r::disable_fan_first_layers)
+                        of seconds (default: $config->{slowdown_below_layer_time})
+    --min-print-speed   Minimum print speed (mm/s, default: $config->{min_print_speed})
+    --disable-fan-first-layers Disable fan for the first N layers (default: $config->{disable_fan_first_layers})
     --fan-always-on     Keep fan always on at min fan speed, even for layers that don't need
                         cooling
    
    Skirt options:
-    --skirts            Number of skirts to draw (0+, default: $Slic3r::skirts)
+    --skirts            Number of skirts to draw (0+, default: $config->{skirts})
     --skirt-distance    Distance in mm between innermost skirt and object 
-                        (default: $Slic3r::skirt_distance)
-    --skirt-height      Height of skirts to draw (expressed in layers, 0+, default: $Slic3r::skirt_height)
+                        (default: $config->{skirt_distance})
+    --skirt-height      Height of skirts to draw (expressed in layers, 0+, default: $config->{skirt_height})
     --brim-width        Width of the brim that will get added to each object to help adhesion
-                        (mm, default: $Slic3r::brim_width)
+                        (mm, default: $config->{brim_width})
    
    Transform options:
-    --scale             Factor for scaling input object (default: $Slic3r::scale)
-    --rotate            Rotation angle in degrees (0-360, default: $Slic3r::rotate)
-    --duplicate         Number of items with auto-arrange (1+, default: $Slic3r::duplicate)
-    --bed-size          Bed size, only used for auto-arrange (mm, default: $Slic3r::bed_size->[0],$Slic3r::bed_size->[1])
-    --duplicate-grid    Number of items with grid arrangement (default: $Slic3r::duplicate_grid->[0],$Slic3r::duplicate_grid->[1])
-    --duplicate-distance Distance in mm between copies (default: $Slic3r::duplicate_distance)
+    --scale             Factor for scaling input object (default: $config->{scale})
+    --rotate            Rotation angle in degrees (0-360, default: $config->{rotate})
+    --duplicate         Number of items with auto-arrange (1+, default: $config->{duplicate})
+    --bed-size          Bed size, only used for auto-arrange (mm, default: $config->{bed_size}->[0],$config->{bed_size}->[1])
+    --duplicate-grid    Number of items with grid arrangement (default: $config->{duplicate_grid}->[0],$config->{duplicate_grid}->[1])
+    --duplicate-distance Distance in mm between copies (default: $config->{duplicate_distance})
    
    Sequential printing options:
     --complete-objects  When printing multiple objects and/or copies, complete each one before
                         starting the next one; watch out for extruder collisions (default: no)
     --extruder-clearance-radius Radius in mm above which extruder won't collide with anything
-                        (default: $Slic3r::extruder_clearance_radius)
+                        (default: $config->{extruder_clearance_radius})
     --extruder-clearance-height Maximum vertical extruder depth; i.e. vertical distance from 
-                        extruder tip and carriage bottom (default: $Slic3r::extruder_clearance_height)
+                        extruder tip and carriage bottom (default: $config->{extruder_clearance_height})
    
    Miscellaneous options:
     --notes             Notes to be added as comments to the output file
@@ -293,7 +288,7 @@ $j
                         Set a different extrusion width for infill
     --support-material-extrusion-width
                         Set a different extrusion width for support material
-    --bridge-flow-ratio Multiplier for extrusion when bridging (> 0, default: $Slic3r::bridge_flow_ratio)
+    --bridge-flow-ratio Multiplier for extrusion when bridging (> 0, default: $config->{bridge_flow_ratio})
   
    Multiple extruder options:
     --perimeters-extruder