git.gag.com Git - debian/gnuradio/blob - grc/src/grc/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 ##@package grc.Preferences
  20 #Holds global paramerences
  21
  22 from Constants import HOME_DIR, FLOW_GRAPH_DTD
  23 import ParseXML
  24 import Messages
  25 import os
  26
  27 ##Access the loaded preferences in this module
  28 _prefs = list()
  29 def _set_prefs(prefs): _prefs.append(prefs)
  30 def _get_prefs(): return _prefs[0]
  31 def load(platform): _Preferences(platform)
  32 def save(): _get_prefs().save()
  33 def get_preferences(): return _get_prefs().get_preferences()
  34
  35 class _Preferences(object):
  36
  37         def __init__(self, platform):
  38                 #make self available to module
  39                 _set_prefs(self)
  40                 #get prefs block
  41                 self._prefs_block = platform.get_prefs_block()
  42                 #prefs file path
  43                 self._prefs_file_path = os.path.join(HOME_DIR, self._prefs_block.get_param('prefs_file').get_value())
  44                 #load
  45                 try:
  46                         ParseXML.validate_dtd(self._prefs_file_path, FLOW_GRAPH_DTD)
  47                         n = ParseXML.from_file(self._prefs_file_path)
  48                         self._prefs_block.import_data(n['block'])
  49                 except: Messages.send_fail_load_preferences(self._prefs_file_path)
  50                 ##all params
  51                 self.snap_to_grid_param = self._prefs_block.get_param('snap_to_grid')
  52                 self.grid_size_param = self._prefs_block.get_param('grid_size')
  53                 self.show_grid_param = self._prefs_block.get_param('show_grid')
  54                 self.show_reports_param = self._prefs_block.get_param('show_reports')
  55                 self.restore_files_param = self._prefs_block.get_param('restore_files')
  56                 self.window_size_param = self._prefs_block.get_param('window_size')
  57                 self.file_open_param = self._prefs_block.get_param('file_open')
  58                 self.files_open_param = self._prefs_block.get_param('files_open')
  59                 self.show_params_param = self._prefs_block.get_param('show_params')
  60                 self.show_id_param = self._prefs_block.get_param('show_id')
  61
  62         def save(self):
  63                 try: ParseXML.to_file({'block': self._prefs_block.export_data()}, self._prefs_file_path)
  64                 except IOError: Messages.send_fail_save_preferences(self._prefs_file_path)
  65
  66         def get_preferences(self):
  67                 ##Preferences: title, notes, params
  68                 return [
  69                         (
  70                                 'Grid',
  71                                 '''
  72 Show grid will draw a square grid onto the flow graph with grid points separated by grid size pixels. \
  73 Snap to Grid forces the upper right corner of the signal block to align with a grid point.
  74 ''',
  75                                 [self.snap_to_grid_param, self.grid_size_param, self.show_grid_param],
  76                         ),
  77                         (
  78                                 'Appearance',
  79                                 '''
  80 Show or hide the reports window at the bottom of the main window.
  81 Show or hide all paramater labels in the signal blocks.
  82 Show or hide the ID label in the signal blocks.
  83 ''',
  84                                 [self.show_reports_param, self.show_params_param, self.show_id_param],
  85                         ),
  86                         (
  87                                 'Misc',
  88                                 '''
  89 Restore previously opened files on start-up.
  90 ''',
  91                                 [self.restore_files_param],
  92                         ),
  93                 ]
  94
  95 ###########################################################################
  96 #       Special methods for specific program functionalities
  97 ###########################################################################
  98
  99 def window_size(size=None):
 100         if size: _get_prefs().window_size_param.set_value(size)
 101         else:
 102                 try: return eval(_get_prefs().window_size_param.get_value())
 103                 except: return (-1, -1)
 104
 105 def restore_files():
 106         return _get_prefs().restore_files_param.get_value() == 'yes'
 107
 108 def file_open(file=None):
 109         if file is not None: _get_prefs().file_open_param.set_value(file)
 110         else: return _get_prefs().file_open_param.get_value()
 111
 112 def files_open(files=None):
 113         if files is not None: _get_prefs().files_open_param.set_value('\n'.join(files))
 114         else: return _get_prefs().files_open_param.get_value().split('\n')
 115
 116 def show_reports_window():
 117         return _get_prefs().show_reports_param.get_value() == 'show'
 118
 119 def get_grid_size():
 120         return int(_get_prefs().grid_size_param.get_value())
 121
 122 def snap_to_grid():
 123         return _get_prefs().snap_to_grid_param.get_value() == 'on'
 124
 125 def show_grid():
 126         return _get_prefs().show_grid_param.get_value() == 'show'
 127
 128 def show_params():
 129         return _get_prefs().show_params_param.get_value() == 'show'
 130
 131 def show_id():
 132         return _get_prefs().show_id_param.get_value() == 'show'
 133