Implement saving settings

qu1ck · qu1ck · commit e32d0685238f · 2018-11-18T23:28:15.000-08:00
diff --git a/.gitignore b/.gitignore
@@ -4,3 +4,4 @@
 test
 releases
 demo
+config.ini
diff --git a/InteractiveHtmlBom/config.py b/InteractiveHtmlBom/config.py
@@ -1,12 +1,16 @@
 """Config object"""
 
 import argparse
+import os
+
+from wx import FileConfig
 
 import dialog.settings_dialog
 
 
 class Config:
     # Helper constants
+    config_file = os.path.join(os.path.dirname(__file__), 'config.ini')
     bom_view_choices = ['bom-only', 'left-right', 'top-bottom']
     layer_view_choices = ['F', 'FB', 'B']
     default_sort_order = [
@@ -29,8 +33,8 @@ class Config:
     redraw_on_drag = True
     board_rotation = 0
     checkboxes = ','.join(default_checkboxes)
-    bom_view = 1
-    layer_view = 1
+    bom_view = bom_view_choices[1]
+    layer_view = layer_view_choices[1]
     open_browser = True
 
     # General section
@@ -49,8 +53,88 @@ class Config:
     dnp_field = ''
 
     def __init__(self):
-        """Init with defaults"""
-        pass
+        """Init from config file if it exists."""
+        if not os.path.isfile(self.config_file):
+            return
+        f = FileConfig(localFilename=self.config_file)
+
+        f.SetPath('/html_defaults')
+        self.dark_mode = f.ReadBool('dark_mode', self.dark_mode)
+        self.show_silkscreen = f.ReadBool(
+                'show_silkscreen', self.show_silkscreen)
+        self.highlight_pin1 = f.ReadBool('highlight_pin1', self.highlight_pin1)
+        self.redraw_on_drag = f.ReadBool('redraw_on_drag', self.redraw_on_drag)
+        self.board_rotation = f.ReadInt('board_rotation', self.board_rotation)
+        self.checkboxes = f.Read('checkboxes', self.checkboxes)
+        self.bom_view = f.Read('bom_view', self.bom_view)
+        self.layer_view = f.Read('layer_view', self.layer_view)
+        self.open_browser = f.ReadBool('open_browser', self.open_browser)
+
+        f.SetPath('/general')
+        self.bom_dest_dir = f.Read('bom_dest_dir', self.bom_dest_dir)
+        self.component_sort_order = f.Read(
+                'component_sort_order',
+                ','.join(self.component_sort_order)
+        ).split(',')
+        self.component_blacklist = f.Read(
+                'component_blacklist',
+                ','.join(self.component_blacklist)
+        ).split(',')
+        self.blacklist_virtual = f.ReadBool(
+                'blacklist_virtual', self.blacklist_virtual)
+
+        f.SetPath('/extra_fields')
+        self.extra_fields = f.Read(
+                'extra_fields',
+                ','.join(self.extra_fields)
+        ).split(',')
+        self.board_variant_field = f.Read(
+                'board_variant_field', self.board_variant_field)
+        self.board_variant_whitelist = f.Read(
+                'board_variant_whitelist',
+                ','.join(self.board_variant_whitelist)
+        ).split(',')
+        self.board_variant_blacklist = f.Read(
+                'board_variant_blacklist',
+                ','.join(self.board_variant_blacklist)
+        ).split(',')
+        self.dnp_field = f.Read('dnp_field', self.dnp_field)
+
+    def save(self):
+        f = FileConfig(localFilename=self.config_file)
+
+        f.SetPath('/html_defaults')
+        f.WriteBool('dark_mode', self.dark_mode)
+        f.WriteBool('show_silkscreen', self.show_silkscreen)
+        f.WriteBool('highlight_pin1', self.highlight_pin1)
+        f.WriteBool('redraw_on_drag', self.redraw_on_drag)
+        f.WriteInt('board_rotation', self.board_rotation)
+        f.Write('checkboxes', self.checkboxes)
+        f.Write('bom_view', self.bom_view)
+        f.Write('layer_view', self.layer_view)
+        f.WriteBool('open_browser', self.open_browser)
+
+        f.SetPath('/general')
+        bom_dest_dir = self.bom_dest_dir
+        if bom_dest_dir.startswith(self.netlist_initial_directory):
+            bom_dest_dir = os.path.relpath(
+                    bom_dest_dir, self.netlist_initial_directory)
+        f.Write('bom_dest_dir', bom_dest_dir)
+        f.Write('component_sort_order',
+                ','.join(self.component_sort_order))
+        f.Write('component_blacklist',
+                ','.join(self.component_blacklist))
+        f.WriteBool('blacklist_virtual', self.blacklist_virtual)
+
+        f.SetPath('/extra_fields')
+        f.Write('extra_fields', ','.join(self.extra_fields))
+        f.Write('board_variant_field', self.board_variant_field)
+        f.Write('board_variant_whitelist',
+                ','.join(self.board_variant_whitelist))
+        f.Write('board_variant_blacklist',
+                ','.join(self.board_variant_blacklist))
+        f.Write('dnp_field', self.dnp_field)
+        f.Flush()
 
     def set_from_dialog(self, dlg):
         # type: (dialog.settings_dialog.SettingsDialogPanel) -> None
@@ -96,8 +180,10 @@ def transfer_to_dialog(self, dlg):
         dlg.html.continuousRedrawCheckbox.value = self.redraw_on_drag
         dlg.html.boardRotationSlider.Value = self.board_rotation
         dlg.html.bomCheckboxesCtrl.Value = self.checkboxes
-        dlg.html.bomDefaultView.Selection = self.bom_view
-        dlg.html.layerDefaultView.Selection = self.layer_view
+        dlg.html.bomDefaultView.Selection = self.bom_view_choices.index(
+                self.bom_view)
+        dlg.html.layerDefaultView.Selection = self.layer_view_choices.index(
+                self.layer_view)
         dlg.html.openBrowserCheckbox.Value = self.open_browser
 
         # General
@@ -114,14 +200,22 @@ def transfer_to_dialog(self, dlg):
         # Extra fields
         dlg.extra.netlistFilePicker.SetInitialDirectory(
                 self.netlist_initial_directory)
-        dlg.extra.extraFieldsList.SetCheckedStrings(self.extra_fields)
+
+        def safe_set_checked_strings(clb, strings):
+            safe_strings = list(clb.GetStrings())
+            clb.SetCheckedStrings([s for s in strings if s in safe_strings])
+
+        safe_set_checked_strings(dlg.extra.extraFieldsList, self.extra_fields)
         dlg.extra.boardVariantFieldBox.Value = self.board_variant_field
-        dlg.extra.boardVariantWhitelist.SetCheckedStrings(
-                self.board_variant_whitelist)
-        dlg.extra.boardVariantBlacklist.SetCheckedStrings(
-                self.board_variant_blacklist)
+        dlg.extra.OnBoardVariantFieldChange(None)
+        safe_set_checked_strings(dlg.extra.boardVariantWhitelist,
+                                 self.board_variant_whitelist)
+        safe_set_checked_strings(dlg.extra.boardVariantBlacklist,
+                                 self.board_variant_blacklist)
         dlg.extra.dnpFieldBox.Value = self.dnp_field
 
+        dlg.finish_init()
+
     # noinspection PyTypeChecker
     @classmethod
     def add_options(cls, parser):
diff --git a/InteractiveHtmlBom/dialog/dialog_base.py b/InteractiveHtmlBom/dialog/dialog_base.py
@@ -46,8 +46,6 @@ def __init__( self, parent, id = wx.ID_ANY, pos = wx.DefaultPosition, size = wx.
         bSizer39 = wx.BoxSizer( wx.HORIZONTAL )
         
         self.m_button41 = wx.Button( self, wx.ID_ANY, u"Save current settings", wx.DefaultPosition, wx.DefaultSize, 0|wx.BORDER_DEFAULT )
-        self.m_button41.Enable( False )
-        
         bSizer39.Add( self.m_button41, 0, wx.ALL, 5 )
         
         
diff --git a/InteractiveHtmlBom/dialog/settings_dialog.py b/InteractiveHtmlBom/dialog/settings_dialog.py
@@ -12,9 +12,10 @@ def pop_error(msg):
 
 
 class SettingsDialog(dialog_base.SettingsDialogBase):
-    def __init__(self, parent, extra_data_func):
-        dialog_base.SettingsDialogBase.__init__(self, parent)
-        self.panel = SettingsDialogPanel(self, extra_data_func)
+    def __init__(self, extra_data_func, config_save_func):
+        dialog_base.SettingsDialogBase.__init__(self, None)
+        self.panel = SettingsDialogPanel(
+                self, extra_data_func, config_save_func)
         best_size = self.panel.BestSize
         # hack for some gtk themes that incorrectly calculate best size
         best_size.IncBy(dx=0, dy=30)
@@ -27,31 +28,33 @@ def SetSizeHints(self, sz1, sz2):
 
     def set_extra_data_path(self, extra_data_file):
         self.panel.extra.netlistFilePicker.Path = extra_data_file
-        wx.CallAfter(self.panel.extra.OnNetlistFileChanged, None)
+        self.panel.extra.OnNetlistFileChanged(None)
 
 
 # Implementing settings_dialog
 class SettingsDialogPanel(dialog_base.SettingsDialogPanel):
-    def __init__(self, parent, extra_data_func):
+    def __init__(self, parent, extra_data_func, config_save_func):
+        self.config_save_func = config_save_func
         dialog_base.SettingsDialogPanel.__init__(self, parent)
         self.general = GeneralSettingsPanel(self.notebook)
         self.html = HtmlSettingsPanel(self.notebook)
         self.extra = ExtraFieldsPanel(self.notebook, extra_data_func)
         self.notebook.AddPage(self.general, "General")
         self.notebook.AddPage(self.html, "Html defaults")
         self.notebook.AddPage(self.extra, "Extra fields")
-        self.html.OnBoardRotationSlider(None)
 
     def OnExit(self, event):
         self.GetParent().EndModal(wx.ID_CANCEL)
 
     def OnSaveSettings(self, event):
-        # TODO: implement OnSaveSettings
-        pass
+        self.config_save_func(self)
 
     def OnGenerateBom(self, event):
         self.GetParent().EndModal(wx.ID_OK)
 
+    def finish_init(self):
+        self.html.OnBoardRotationSlider(None)
+
 
 # Implementing HtmlSettingsPanelBase
 class HtmlSettingsPanel(dialog_base.HtmlSettingsPanelBase):
diff --git a/InteractiveHtmlBom/generate_interactive_bom.py b/InteractiveHtmlBom/generate_interactive_bom.py
@@ -598,6 +598,29 @@ def main(pcb, config):
         open_file(bom_file)
 
 
+def run_with_dialog(board, config):
+    def save_config(dialog_panel):
+        config.set_from_dialog(dialog_panel)
+        config.save()
+
+    dlg = dialog.SettingsDialog(
+            extra_data_func=parse_schematic_data,
+            config_save_func=save_config
+    )
+    try:
+        pcb_file_name = board.GetFileName()
+        config.netlist_initial_directory = os.path.dirname(pcb_file_name)
+        extra_data_file = find_latest_schematic_data(pcb_file_name)
+        if extra_data_file is not None:
+            dlg.set_extra_data_path(extra_data_file)
+        config.transfer_to_dialog(dlg.panel)
+        if dlg.ShowModal() == wx.ID_OK:
+            config.set_from_dialog(dlg.panel)
+            main(board, config)
+    finally:
+        dlg.Destroy()
+
+
 class GenerateInteractiveBomPlugin(pcbnew.ActionPlugin):
 
     def defaults(self):
@@ -624,22 +647,12 @@ def Run(self):
             logerror('Please save the board file before generating BOM.')
             return
 
-        dlg = dialog.SettingsDialog(None, extra_data_func=parse_schematic_data)
-        try:
-            config.netlist_initial_directory = os.path.dirname(pcb_file_name)
-            extra_data_file = find_latest_schematic_data(pcb_file_name)
-            if extra_data_file is not None:
-                dlg.set_extra_data_path(extra_data_file)
-            config.transfer_to_dialog(dlg.panel)
-            if dlg.ShowModal() == wx.ID_OK:
-                config.set_from_dialog(dlg.panel)
-                main(pcbnew.GetBoard(), config)
-        finally:
-            dlg.Destroy()
+        run_with_dialog(pcbnew.GetBoard(), config)
 
 
 if __name__ == "__main__":
     is_cli = True
+    app = wx.App()
 
     import argparse
 
@@ -654,18 +667,9 @@ def Run(self):
         print("File %s does not exist." % args.file)
         exit(1)
     print("Loading %s" % args.file)
-    app = wx.App()
     board = pcbnew.LoadBoard(os.path.abspath(args.file).decode('utf8'))
     if args.show_dialog:
-        # Create simple app to show config dialog, infer config.
-        dlg = dialog.SettingsDialog(None, extra_data_func=parse_schematic_data)
-        config.netlist_initial_directory = os.path.dirname(args.file)
-        config.transfer_to_dialog(dlg.panel)
-        if dlg.ShowModal() == wx.ID_OK:
-            config.set_from_dialog(dlg.panel)
-            print config.get_html_config()
-            main(board, config)
-        dlg.Destroy()
+        run_with_dialog(board, config)
     else:
         config.set_from_args(args)
         main(board, config)
diff --git a/settings_dialog.fbp b/settings_dialog.fbp
@@ -296,7 +296,7 @@
                                 <property name="dock">Dock</property>
                                 <property name="dock_fixed">0</property>
                                 <property name="docking">Left</property>
-                                <property name="enabled">0</property>
+                                <property name="enabled">1</property>
                                 <property name="fg"></property>
                                 <property name="floatable">1</property>
                                 <property name="focus"></property>
