Option added to only dump settings that differ from the defaults

Author: Seeker04

README.md

@@ -250,7 +250,7 @@ hooks([
 
 * `set/2` and `add/2` can be used to overwrite or append to existing settings, respectively. You can invoke them via a keymap, the [command fifo](#scriptability) or the [command menu](#menus).
 * The whole configuration file can be reloaded by calling `reload_config/0`.
-* You can use `dump_settings/1` to dump all current settings to a file.
+* You can use `dump_settings(Path, false)` to dump all current settings and `dump_settings(Path, true)` to dump only those that differ from the defaults to a file. Both are available in the command menu.
 
 ## External bars
 

src/menu.pl

@@ -367,10 +367,11 @@
 cmd_desc(menu:reindex_workspace, "Reindex selected workspace").
 cmd_desc(menu:delete_workspaces, "Delete selected workspaces").
 cmd_desc(menu:list_keymaps     , "List all defined keymaps").
+cmd_desc(shellcmd              , "Run a shell command").
+cmd_desc(reload_config         , "Reload configuration file").
+cmd_desc(dump_settings         , "Dump current settings to a file").
+cmd_desc(dump_changed_settings , "Dump settings that differ from the defaults to a file").
 cmd_desc(shellcmd(Cmd), D) :- format(string(D), "Run `~s`", [Cmd]).
-cmd_desc(shellcmd, "Run a shell command").
-cmd_desc(reload_config, "Reload configuration file").
-cmd_desc(dump_settings, "Dump current settings to a file").
 cmd_desc(set(Setting), D) :- string_concat("Change setting ", Setting, D).
 cmd_desc(add(Setting), D) :- string_concat("Add to setting ", Setting, D).
 
@@ -437,10 +438,19 @@
 
 %! dump_settings_prompt() is det
 %
-%  Prompts the user for a path to dump settings to. See dump_settings/1 for details.
+%  Prompts the user for a path to dump settings to. See dump_settings/2 for details.
 dump_settings_prompt() :-
 	(read_from_prompt("Dump settings to", Input) ->
-		dump_settings(Input)
+		dump_settings(Input, false)
+	; true)
+.
+
+%! dump_changed_settings_prompt() is det
+%
+%  Prompts the user for a path to dump changed settings to. See dump_settings/2 for details.
+dump_changed_settings_prompt() :-
+	(read_from_prompt("Dump changed settings to", Input) ->
+		dump_settings(Input, true)
 	; true)
 .
 
@@ -454,12 +464,13 @@
 %  @arg Selection list of selections - unused, filled be spawn_menu/3
 run_cmd(MenuEntries, [Selection]) :-
 	(member(Cmd-Selection, MenuEntries) ->
-		(Cmd = set(Setting)   -> change_setting_prompt(Setting, false)
-		;Cmd = add(Setting)   -> change_setting_prompt(Setting, true)
-		;Cmd = change_nmaster -> change_nmaster_prompt
-		;Cmd = change_mfact   -> change_mfact_prompt
-		;Cmd = shellcmd       -> shellcmd_prompt
-		;Cmd = dump_settings  -> dump_settings_prompt
+		(Cmd = set(Setting)          -> change_setting_prompt(Setting, false)
+		;Cmd = add(Setting)          -> change_setting_prompt(Setting, true)
+		;Cmd = change_nmaster        -> change_nmaster_prompt
+		;Cmd = change_mfact          -> change_mfact_prompt
+		;Cmd = shellcmd              -> shellcmd_prompt
+		;Cmd = dump_settings         -> dump_settings_prompt
+		;Cmd = dump_changed_settings -> dump_changed_settings_prompt
 		;call(Cmd))
 	; true)
 .
@@ -591,6 +602,7 @@
 		shellcmd,
 		reload_config,
 		dump_settings,
+		dump_changed_settings,
 		set(default_nmaster),
 		set(default_mfact),
 		set(default_layout),

src/plwm.pl

@@ -2215,18 +2215,21 @@
 	nb_delete(settings_snapshot)
 .
 
-%! dump_settings(++FilePath:string) is det
+%! dump_settings(++FilePath:string, ++OnlyChanged:bool) is det
 %
-%  Dumps all current settings to a file.
+%  Dumps current settings to a file.
 %
 %  @arg FilePath path of file to create
-dump_settings(FilePath) :-
+%  @arg OnlyChanged whether to only dump settings that differ from their default values
+dump_settings(FilePath, OnlyChanged) :-
 	open(FilePath, write, DumpFile),
 	forall(setting:setting(Setting), (
 		call(Setting, Value),
-		compound_name_arguments(Config, Setting, [Value]),
-		write_term(DumpFile, Config, [quoted(true), spacing(next_argument)]),
-		writeln(DumpFile, ".")
+		((OnlyChanged = false ; \+ setting:default_set(Setting, Value)) ->
+			compound_name_arguments(Config, Setting, [Value]),
+			write_term(DumpFile, Config, [quoted(true), spacing(next_argument)]),
+			writeln(DumpFile, ".")
+		; true)
 	)),
 	close(DumpFile)
 .

tests/unit_tests/menu.plt

@@ -657,20 +657,34 @@ test("change_setting_prompt - (add)", [
 	menu:change_setting_prompt(hooks, true)
 .
 
-test("change_setting_prompt", [
+test("dump_settings_prompt", [
 	setup((
 		% we omit from the output the prompt read_from_prompt/0 appends
 		assertz(menu:menucmd(["sh", "-c", "echo $0", "somefile"])),
-		assertz(menu:dump_settings(FilePath) :- string(FilePath))
+		assertz(menu:dump_settings(FilePath, false) :- string(FilePath))
 	)),
 	cleanup((
 		retract(menu:menucmd(_)),
-		retract(menu:dump_settings(_))
+		retract(menu:dump_settings(_, _))
 	))
 ]) :-
 	assertion(menu:dump_settings_prompt)
 .
 
+test("dump_changed_settings_prompt", [
+	setup((
+		% we omit from the output the prompt read_from_prompt/0 appends
+		assertz(menu:menucmd(["sh", "-c", "echo $0", "somefile"])),
+		assertz(menu:dump_settings(FilePath, true) :- string(FilePath))
+	)),
+	cleanup((
+		retract(menu:menucmd(_)),
+		retract(menu:dump_settings(_, _))
+	))
+]) :-
+	assertion(menu:dump_changed_settings_prompt)
+.
+
 test("run_cmd +") :-
 	assertion(menu:run_cmd([false-"foo", true-"selected", false-"bar"], ["selected"])),
 	assertion(menu:run_cmd([false-"foo", false-"bar"], ["selected"]))