git.gag.com Git - debian/gnuradio/blob - grc/src/gui/Preferences.py

   1 """
   2 Copyright 2008 Free Software Foundation, Inc.
   3 This file is part of GNU Radio
   4
   5 GNU Radio Companion is free software; you can redistribute it and/or
   6 modify it under the terms of the GNU General Public License
   7 as published by the Free Software Foundation; either version 2
   8 of the License, or (at your option) any later version.
   9
  10 GNU Radio Companion is distributed in the hope that it will be useful,
  11 but WITHOUT ANY WARRANTY; without even the implied warranty of
  12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13 GNU General Public License for more details.
  14
  15 You should have received a copy of the GNU General Public License
  16 along with this program; if not, write to the Free Software
  17 Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA
  18 """
  19
  20 from .. platforms.base.Constants import HOME_DIR, FLOW_GRAPH_DTD
  21 from .. utils import ParseXML
  22 import Messages
  23 import os
  24
  25 ##Access the loaded preferences in this module
  26 _prefs = list()
  27 def _set_prefs(prefs): _prefs.append(prefs)
  28 def _get_prefs(): return _prefs[0]
  29 def load(platform): _Preferences(platform)
  30 def save(): _get_prefs().save()
  31 def get_preferences(): return _get_prefs().get_preferences()
  32
  33 class _Preferences(object):
  34
  35         def __init__(self, platform):
  36                 #make self available to module
  37                 _set_prefs(self)
  38                 #get prefs block
  39                 self._prefs_block = platform.get_prefs_block()
  40                 #prefs file path
  41                 self._prefs_file_path = os.path.join(HOME_DIR, self._prefs_block.get_param('prefs_file').get_value())
  42                 #load
  43                 try:
  44                         ParseXML.validate_dtd(self._prefs_file_path, FLOW_GRAPH_DTD)
  45                         n = ParseXML.from_file(self._prefs_file_path)
  46                         self._prefs_block.import_data(n['block'])
  47                 except: Messages.send_fail_load_preferences(self._prefs_file_path)
  48                 ##all params
  49                 self.snap_to_grid_param = self._prefs_block.get_param('snap_to_grid')
  50                 self.grid_size_param = self._prefs_block.get_param('grid_size')
  51                 self.show_grid_param = self._prefs_block.get_param('show_grid')
  52                 self.show_reports_param = self._prefs_block.get_param('show_reports')
  53                 self.restore_files_param = self._prefs_block.get_param('restore_files')
  54                 self.window_size_param = self._prefs_block.get_param('window_size')
  55                 self.file_open_param = self._prefs_block.get_param('file_open')
  56                 self.files_open_param = self._prefs_block.get_param('files_open')
  57                 self.show_params_param = self._prefs_block.get_param('show_params')
  58                 self.show_id_param = self._prefs_block.get_param('show_id')
  59
  60         def save(self):
  61                 try: ParseXML.to_file({'block': self._prefs_block.export_data()}, self._prefs_file_path)
  62                 except IOError: Messages.send_fail_save_preferences(self._prefs_file_path)
  63
  64         def get_preferences(self):
  65                 ##Preferences: title, notes, params
  66                 return [
  67                         (
  68                                 'Grid',
  69                                 '''
  70 Show grid will draw a square grid onto the flow graph with grid points separated by grid size pixels. \
  71 Snap to Grid forces the upper right corner of the signal block to align with a grid point.
  72 ''',
  73                                 [self.snap_to_grid_param, self.grid_size_param, self.show_grid_param],
  74                         ),
  75                         (
  76                                 'Appearance',
  77                                 '''
  78 Show or hide the reports window at the bottom of the main window.
  79 Show or hide all paramater labels in the signal blocks.
  80 Show or hide the ID label in the signal blocks.
  81 ''',
  82                                 [self.show_reports_param, self.show_params_param, self.show_id_param],
  83                         ),
  84                         (
  85                                 'Misc',
  86                                 '''
  87 Restore previously opened files on start-up.
  88 ''',
  89                                 [self.restore_files_param],
  90                         ),
  91                 ]
  92
  93 ###########################################################################
  94 # Special methods for specific program functionalities
  95 ###########################################################################
  96
  97 def window_size(size=None):
  98         if size: _get_prefs().window_size_param.set_value(size)
  99         else:
 100                 try: return eval(_get_prefs().window_size_param.get_value())
 101                 except: return (-1, -1)
 102
 103 def restore_files():
 104         return _get_prefs().restore_files_param.get_value() == 'yes'
 105
 106 def file_open(file=None):
 107         if file is not None: _get_prefs().file_open_param.set_value(file)
 108         else: return _get_prefs().file_open_param.get_value()
 109
 110 def files_open(files=None):
 111         if files is not None: _get_prefs().files_open_param.set_value('\n'.join(files))
 112         else: return _get_prefs().files_open_param.get_value().split('\n')
 113
 114 def show_reports_window():
 115         return _get_prefs().show_reports_param.get_value() == 'show'
 116
 117 def get_grid_size():
 118         return int(_get_prefs().grid_size_param.get_value())
 119
 120 def snap_to_grid():
 121         return _get_prefs().snap_to_grid_param.get_value() == 'on'
 122
 123 def show_grid():
 124         return _get_prefs().show_grid_param.get_value() == 'show'
 125
 126 def show_params():
 127         return _get_prefs().show_params_param.get_value() == 'show'
 128
 129 def show_id():
 130         return _get_prefs().show_id_param.get_value() == 'show'