Terry Jan Reedy | f46b782 | 2016-11-07 17:15:01 -0500 | [diff] [blame] | 1 | """idlelib.config -- Manage IDLE configuration information. |
Steven M. Gava | c597640 | 2002-01-04 03:06:08 +0000 | [diff] [blame] | 2 | |
Terry Jan Reedy | f46b782 | 2016-11-07 17:15:01 -0500 | [diff] [blame] | 3 | The comments at the beginning of config-main.def describe the |
| 4 | configuration files and the design implemented to update user |
| 5 | configuration information. In particular, user configuration choices |
| 6 | which duplicate the defaults will be removed from the user's |
| 7 | configuration files, and if a user file becomes empty, it will be |
| 8 | deleted. |
Kurt B. Kaiser | 8e92bf7 | 2003-01-14 22:03:31 +0000 | [diff] [blame] | 9 | |
Terry Jan Reedy | f46b782 | 2016-11-07 17:15:01 -0500 | [diff] [blame] | 10 | The configuration database maps options to values. Comceptually, the |
| 11 | database keys are tuples (config-type, section, item). As implemented, |
| 12 | there are separate dicts for default and user values. Each has |
| 13 | config-type keys 'main', 'extensions', 'highlight', and 'keys'. The |
| 14 | value for each key is a ConfigParser instance that maps section and item |
| 15 | to values. For 'main' and 'extenstons', user values override |
| 16 | default values. For 'highlight' and 'keys', user sections augment the |
| 17 | default sections (and must, therefore, have distinct names). |
Kurt B. Kaiser | 8e92bf7 | 2003-01-14 22:03:31 +0000 | [diff] [blame] | 18 | |
| 19 | Throughout this module there is an emphasis on returning useable defaults |
| 20 | when a problem occurs in returning a requested configuration value back to |
| 21 | idle. This is to allow IDLE to continue to function in spite of errors in |
| 22 | the retrieval of config information. When a default is returned instead of |
| 23 | a requested config value, a message is printed to stderr to aid in |
| 24 | configuration problem notification and resolution. |
Kurt B. Kaiser | 8e92bf7 | 2003-01-14 22:03:31 +0000 | [diff] [blame] | 25 | """ |
Terry Jan Reedy | deb7bf1 | 2014-10-06 23:26:26 -0400 | [diff] [blame] | 26 | # TODOs added Oct 2014, tjr |
| 27 | |
Terry Jan Reedy | bfbaa6b | 2016-08-31 00:50:55 -0400 | [diff] [blame] | 28 | from configparser import ConfigParser |
Kurt B. Kaiser | 8e92bf7 | 2003-01-14 22:03:31 +0000 | [diff] [blame] | 29 | import os |
| 30 | import sys |
Guido van Rossum | 36e0a92 | 2007-07-20 04:05:57 +0000 | [diff] [blame] | 31 | |
Terry Jan Reedy | d87d168 | 2015-08-01 18:57:33 -0400 | [diff] [blame] | 32 | from tkinter.font import Font, nametofont |
Steven M. Gava | c11ccf3 | 2001-09-24 09:43:17 +0000 | [diff] [blame] | 33 | |
Neal Norwitz | 5b0b00f | 2002-11-30 19:10:19 +0000 | [diff] [blame] | 34 | class InvalidConfigType(Exception): pass |
| 35 | class InvalidConfigSet(Exception): pass |
| 36 | class InvalidFgBg(Exception): pass |
| 37 | class InvalidTheme(Exception): pass |
| 38 | |
Steven M. Gava | c11ccf3 | 2001-09-24 09:43:17 +0000 | [diff] [blame] | 39 | class IdleConfParser(ConfigParser): |
| 40 | """ |
| 41 | A ConfigParser specialised for idle configuration file handling |
| 42 | """ |
| 43 | def __init__(self, cfgFile, cfgDefaults=None): |
| 44 | """ |
| 45 | cfgFile - string, fully specified configuration file name |
| 46 | """ |
Terry Jan Reedy | deb7bf1 | 2014-10-06 23:26:26 -0400 | [diff] [blame] | 47 | self.file = cfgFile |
Serhiy Storchaka | 8995300 | 2013-02-07 15:24:36 +0200 | [diff] [blame] | 48 | ConfigParser.__init__(self, defaults=cfgDefaults, strict=False) |
Kurt B. Kaiser | 6655e4b | 2002-12-31 16:03:23 +0000 | [diff] [blame] | 49 | |
Thomas Wouters | cf297e4 | 2007-02-23 15:07:44 +0000 | [diff] [blame] | 50 | def Get(self, section, option, type=None, default=None, raw=False): |
Steven M. Gava | c11ccf3 | 2001-09-24 09:43:17 +0000 | [diff] [blame] | 51 | """ |
| 52 | Get an option value for given section/option or return default. |
| 53 | If type is specified, return as type. |
| 54 | """ |
Terry Jan Reedy | a9421fb | 2014-10-22 20:15:18 -0400 | [diff] [blame] | 55 | # TODO Use default as fallback, at least if not None |
| 56 | # Should also print Warning(file, section, option). |
| 57 | # Currently may raise ValueError |
Thomas Wouters | cf297e4 | 2007-02-23 15:07:44 +0000 | [diff] [blame] | 58 | if not self.has_option(section, option): |
Steven M. Gava | f9bb90e | 2002-01-24 06:02:50 +0000 | [diff] [blame] | 59 | return default |
Terry Jan Reedy | deb7bf1 | 2014-10-06 23:26:26 -0400 | [diff] [blame] | 60 | if type == 'bool': |
Thomas Wouters | cf297e4 | 2007-02-23 15:07:44 +0000 | [diff] [blame] | 61 | return self.getboolean(section, option) |
Terry Jan Reedy | deb7bf1 | 2014-10-06 23:26:26 -0400 | [diff] [blame] | 62 | elif type == 'int': |
Thomas Wouters | cf297e4 | 2007-02-23 15:07:44 +0000 | [diff] [blame] | 63 | return self.getint(section, option) |
| 64 | else: |
| 65 | return self.get(section, option, raw=raw) |
Steven M. Gava | c11ccf3 | 2001-09-24 09:43:17 +0000 | [diff] [blame] | 66 | |
Terry Jan Reedy | deb7bf1 | 2014-10-06 23:26:26 -0400 | [diff] [blame] | 67 | def GetOptionList(self, section): |
| 68 | "Return a list of options for given section, else []." |
Steven M. Gava | 085eb1b | 2002-02-05 04:52:32 +0000 | [diff] [blame] | 69 | if self.has_section(section): |
Steven M. Gava | c11ccf3 | 2001-09-24 09:43:17 +0000 | [diff] [blame] | 70 | return self.options(section) |
| 71 | else: #return a default value |
| 72 | return [] |
| 73 | |
Steven M. Gava | c11ccf3 | 2001-09-24 09:43:17 +0000 | [diff] [blame] | 74 | def Load(self): |
Terry Jan Reedy | deb7bf1 | 2014-10-06 23:26:26 -0400 | [diff] [blame] | 75 | "Load the configuration file from disk." |
Steven M. Gava | c11ccf3 | 2001-09-24 09:43:17 +0000 | [diff] [blame] | 76 | self.read(self.file) |
Kurt B. Kaiser | 6655e4b | 2002-12-31 16:03:23 +0000 | [diff] [blame] | 77 | |
Steven M. Gava | c11ccf3 | 2001-09-24 09:43:17 +0000 | [diff] [blame] | 78 | class IdleUserConfParser(IdleConfParser): |
| 79 | """ |
Steven M. Gava | 2d7bb3f | 2002-01-29 08:35:29 +0000 | [diff] [blame] | 80 | IdleConfigParser specialised for user configuration handling. |
Steven M. Gava | c11ccf3 | 2001-09-24 09:43:17 +0000 | [diff] [blame] | 81 | """ |
Steven M. Gava | 2d7bb3f | 2002-01-29 08:35:29 +0000 | [diff] [blame] | 82 | |
Terry Jan Reedy | deb7bf1 | 2014-10-06 23:26:26 -0400 | [diff] [blame] | 83 | def AddSection(self, section): |
| 84 | "If section doesn't exist, add it." |
Steven M. Gava | 2d7bb3f | 2002-01-29 08:35:29 +0000 | [diff] [blame] | 85 | if not self.has_section(section): |
| 86 | self.add_section(section) |
Kurt B. Kaiser | 6655e4b | 2002-12-31 16:03:23 +0000 | [diff] [blame] | 87 | |
Steven M. Gava | 2d7bb3f | 2002-01-29 08:35:29 +0000 | [diff] [blame] | 88 | def RemoveEmptySections(self): |
Terry Jan Reedy | deb7bf1 | 2014-10-06 23:26:26 -0400 | [diff] [blame] | 89 | "Remove any sections that have no options." |
Steven M. Gava | 2d7bb3f | 2002-01-29 08:35:29 +0000 | [diff] [blame] | 90 | for section in self.sections(): |
| 91 | if not self.GetOptionList(section): |
Kurt B. Kaiser | 6655e4b | 2002-12-31 16:03:23 +0000 | [diff] [blame] | 92 | self.remove_section(section) |
| 93 | |
Steven M. Gava | 2d7bb3f | 2002-01-29 08:35:29 +0000 | [diff] [blame] | 94 | def IsEmpty(self): |
Terry Jan Reedy | deb7bf1 | 2014-10-06 23:26:26 -0400 | [diff] [blame] | 95 | "Return True if no sections after removing empty sections." |
Steven M. Gava | 2d7bb3f | 2002-01-29 08:35:29 +0000 | [diff] [blame] | 96 | self.RemoveEmptySections() |
Terry Jan Reedy | deb7bf1 | 2014-10-06 23:26:26 -0400 | [diff] [blame] | 97 | return not self.sections() |
Kurt B. Kaiser | 6655e4b | 2002-12-31 16:03:23 +0000 | [diff] [blame] | 98 | |
Terry Jan Reedy | deb7bf1 | 2014-10-06 23:26:26 -0400 | [diff] [blame] | 99 | def RemoveOption(self, section, option): |
| 100 | """Return True if option is removed from section, else False. |
| 101 | |
| 102 | False if either section does not exist or did not have option. |
Steven M. Gava | 2d7bb3f | 2002-01-29 08:35:29 +0000 | [diff] [blame] | 103 | """ |
| 104 | if self.has_section(section): |
Terry Jan Reedy | deb7bf1 | 2014-10-06 23:26:26 -0400 | [diff] [blame] | 105 | return self.remove_option(section, option) |
| 106 | return False |
Kurt B. Kaiser | 6655e4b | 2002-12-31 16:03:23 +0000 | [diff] [blame] | 107 | |
Terry Jan Reedy | deb7bf1 | 2014-10-06 23:26:26 -0400 | [diff] [blame] | 108 | def SetOption(self, section, option, value): |
| 109 | """Return True if option is added or changed to value, else False. |
| 110 | |
| 111 | Add section if required. False means option already had value. |
Steven M. Gava | 2d7bb3f | 2002-01-29 08:35:29 +0000 | [diff] [blame] | 112 | """ |
Terry Jan Reedy | deb7bf1 | 2014-10-06 23:26:26 -0400 | [diff] [blame] | 113 | if self.has_option(section, option): |
| 114 | if self.get(section, option) == value: |
| 115 | return False |
Steven M. Gava | 2d7bb3f | 2002-01-29 08:35:29 +0000 | [diff] [blame] | 116 | else: |
Terry Jan Reedy | deb7bf1 | 2014-10-06 23:26:26 -0400 | [diff] [blame] | 117 | self.set(section, option, value) |
| 118 | return True |
Steven M. Gava | 2d7bb3f | 2002-01-29 08:35:29 +0000 | [diff] [blame] | 119 | else: |
| 120 | if not self.has_section(section): |
| 121 | self.add_section(section) |
Terry Jan Reedy | deb7bf1 | 2014-10-06 23:26:26 -0400 | [diff] [blame] | 122 | self.set(section, option, value) |
| 123 | return True |
Kurt B. Kaiser | 6655e4b | 2002-12-31 16:03:23 +0000 | [diff] [blame] | 124 | |
Steven M. Gava | b77d343 | 2002-03-02 07:16:21 +0000 | [diff] [blame] | 125 | def RemoveFile(self): |
Terry Jan Reedy | deb7bf1 | 2014-10-06 23:26:26 -0400 | [diff] [blame] | 126 | "Remove user config file self.file from disk if it exists." |
Steven M. Gava | b77d343 | 2002-03-02 07:16:21 +0000 | [diff] [blame] | 127 | if os.path.exists(self.file): |
Kurt B. Kaiser | 6655e4b | 2002-12-31 16:03:23 +0000 | [diff] [blame] | 128 | os.remove(self.file) |
| 129 | |
Steven M. Gava | c11ccf3 | 2001-09-24 09:43:17 +0000 | [diff] [blame] | 130 | def Save(self): |
Kurt B. Kaiser | 8e92bf7 | 2003-01-14 22:03:31 +0000 | [diff] [blame] | 131 | """Update user configuration file. |
| 132 | |
| 133 | Remove empty sections. If resulting config isn't empty, write the file |
| 134 | to disk. If config is empty, remove the file from disk if it exists. |
| 135 | |
Steven M. Gava | c11ccf3 | 2001-09-24 09:43:17 +0000 | [diff] [blame] | 136 | """ |
Steven M. Gava | 2d7bb3f | 2002-01-29 08:35:29 +0000 | [diff] [blame] | 137 | if not self.IsEmpty(): |
Christian Heimes | bbffeb6 | 2008-01-24 09:42:52 +0000 | [diff] [blame] | 138 | fname = self.file |
| 139 | try: |
| 140 | cfgFile = open(fname, 'w') |
Andrew Svetlov | f7a17b4 | 2012-12-25 16:47:37 +0200 | [diff] [blame] | 141 | except OSError: |
Christian Heimes | 0bd4e11 | 2008-02-12 22:59:25 +0000 | [diff] [blame] | 142 | os.unlink(fname) |
Christian Heimes | bbffeb6 | 2008-01-24 09:42:52 +0000 | [diff] [blame] | 143 | cfgFile = open(fname, 'w') |
Amaury Forgeot d'Arc | bbe7b0a | 2011-10-03 20:33:24 +0200 | [diff] [blame] | 144 | with cfgFile: |
| 145 | self.write(cfgFile) |
Steven M. Gava | 2d7bb3f | 2002-01-29 08:35:29 +0000 | [diff] [blame] | 146 | else: |
Steven M. Gava | b77d343 | 2002-03-02 07:16:21 +0000 | [diff] [blame] | 147 | self.RemoveFile() |
Steven M. Gava | c11ccf3 | 2001-09-24 09:43:17 +0000 | [diff] [blame] | 148 | |
| 149 | class IdleConf: |
Terry Jan Reedy | deb7bf1 | 2014-10-06 23:26:26 -0400 | [diff] [blame] | 150 | """Hold config parsers for all idle config files in singleton instance. |
| 151 | |
| 152 | Default config files, self.defaultCfg -- |
| 153 | for config_type in self.config_types: |
| 154 | (idle install dir)/config-{config-type}.def |
| 155 | |
| 156 | User config files, self.userCfg -- |
| 157 | for config_type in self.config_types: |
| 158 | (user home dir)/.idlerc/config-{config-type}.cfg |
Steven M. Gava | c11ccf3 | 2001-09-24 09:43:17 +0000 | [diff] [blame] | 159 | """ |
| 160 | def __init__(self): |
Terry Jan Reedy | deb7bf1 | 2014-10-06 23:26:26 -0400 | [diff] [blame] | 161 | self.config_types = ('main', 'extensions', 'highlight', 'keys') |
| 162 | self.defaultCfg = {} |
| 163 | self.userCfg = {} |
| 164 | self.cfg = {} # TODO use to select userCfg vs defaultCfg |
Steven M. Gava | c11ccf3 | 2001-09-24 09:43:17 +0000 | [diff] [blame] | 165 | self.CreateConfigHandlers() |
| 166 | self.LoadCfgFiles() |
Terry Jan Reedy | deb7bf1 | 2014-10-06 23:26:26 -0400 | [diff] [blame] | 167 | |
Kurt B. Kaiser | 6655e4b | 2002-12-31 16:03:23 +0000 | [diff] [blame] | 168 | |
Steven M. Gava | c11ccf3 | 2001-09-24 09:43:17 +0000 | [diff] [blame] | 169 | def CreateConfigHandlers(self): |
Terry Jan Reedy | deb7bf1 | 2014-10-06 23:26:26 -0400 | [diff] [blame] | 170 | "Populate default and user config parser dictionaries." |
Steven M. Gava | c11ccf3 | 2001-09-24 09:43:17 +0000 | [diff] [blame] | 171 | #build idle install path |
| 172 | if __name__ != '__main__': # we were imported |
Steven M. Gava | 7cff66d | 2002-02-01 03:02:37 +0000 | [diff] [blame] | 173 | idleDir=os.path.dirname(__file__) |
Steven M. Gava | c11ccf3 | 2001-09-24 09:43:17 +0000 | [diff] [blame] | 174 | else: # we were exec'ed (for testing only) |
Steven M. Gava | 7cff66d | 2002-02-01 03:02:37 +0000 | [diff] [blame] | 175 | idleDir=os.path.abspath(sys.path[0]) |
| 176 | userDir=self.GetUserCfgDir() |
Terry Jan Reedy | deb7bf1 | 2014-10-06 23:26:26 -0400 | [diff] [blame] | 177 | |
| 178 | defCfgFiles = {} |
| 179 | usrCfgFiles = {} |
| 180 | # TODO eliminate these temporaries by combining loops |
| 181 | for cfgType in self.config_types: #build config file names |
| 182 | defCfgFiles[cfgType] = os.path.join( |
| 183 | idleDir, 'config-' + cfgType + '.def') |
| 184 | usrCfgFiles[cfgType] = os.path.join( |
| 185 | userDir, 'config-' + cfgType + '.cfg') |
| 186 | for cfgType in self.config_types: #create config parsers |
| 187 | self.defaultCfg[cfgType] = IdleConfParser(defCfgFiles[cfgType]) |
| 188 | self.userCfg[cfgType] = IdleUserConfParser(usrCfgFiles[cfgType]) |
Kurt B. Kaiser | 6655e4b | 2002-12-31 16:03:23 +0000 | [diff] [blame] | 189 | |
Steven M. Gava | 7cff66d | 2002-02-01 03:02:37 +0000 | [diff] [blame] | 190 | def GetUserCfgDir(self): |
Terry Jan Reedy | deb7bf1 | 2014-10-06 23:26:26 -0400 | [diff] [blame] | 191 | """Return a filesystem directory for storing user config files. |
Tim Peters | 608c2ff | 2005-01-13 17:37:38 +0000 | [diff] [blame] | 192 | |
Terry Jan Reedy | deb7bf1 | 2014-10-06 23:26:26 -0400 | [diff] [blame] | 193 | Creates it if required. |
Steven M. Gava | 7cff66d | 2002-02-01 03:02:37 +0000 | [diff] [blame] | 194 | """ |
Kurt B. Kaiser | 1b6f398 | 2005-01-11 19:29:39 +0000 | [diff] [blame] | 195 | cfgDir = '.idlerc' |
| 196 | userDir = os.path.expanduser('~') |
| 197 | if userDir != '~': # expanduser() found user home dir |
Steven M. Gava | 7cff66d | 2002-02-01 03:02:37 +0000 | [diff] [blame] | 198 | if not os.path.exists(userDir): |
Terry Jan Reedy | deb7bf1 | 2014-10-06 23:26:26 -0400 | [diff] [blame] | 199 | warn = ('\n Warning: os.path.expanduser("~") points to\n ' + |
| 200 | userDir + ',\n but the path does not exist.') |
Christian Heimes | 81ee3ef | 2008-05-04 22:42:01 +0000 | [diff] [blame] | 201 | try: |
Terry Jan Reedy | 81b062f | 2014-09-19 22:38:41 -0400 | [diff] [blame] | 202 | print(warn, file=sys.stderr) |
Andrew Svetlov | f7a17b4 | 2012-12-25 16:47:37 +0200 | [diff] [blame] | 203 | except OSError: |
Christian Heimes | 81ee3ef | 2008-05-04 22:42:01 +0000 | [diff] [blame] | 204 | pass |
Kurt B. Kaiser | 1b6f398 | 2005-01-11 19:29:39 +0000 | [diff] [blame] | 205 | userDir = '~' |
| 206 | if userDir == "~": # still no path to home! |
| 207 | # traditionally IDLE has defaulted to os.getcwd(), is this adequate? |
| 208 | userDir = os.getcwd() |
| 209 | userDir = os.path.join(userDir, cfgDir) |
Steven M. Gava | 7cff66d | 2002-02-01 03:02:37 +0000 | [diff] [blame] | 210 | if not os.path.exists(userDir): |
Kurt B. Kaiser | 1b6f398 | 2005-01-11 19:29:39 +0000 | [diff] [blame] | 211 | try: |
Steven M. Gava | 7cff66d | 2002-02-01 03:02:37 +0000 | [diff] [blame] | 212 | os.mkdir(userDir) |
Andrew Svetlov | f7a17b4 | 2012-12-25 16:47:37 +0200 | [diff] [blame] | 213 | except OSError: |
Terry Jan Reedy | deb7bf1 | 2014-10-06 23:26:26 -0400 | [diff] [blame] | 214 | warn = ('\n Warning: unable to create user config directory\n' + |
| 215 | userDir + '\n Check path and permissions.\n Exiting!\n') |
Terry Jan Reedy | 81b062f | 2014-09-19 22:38:41 -0400 | [diff] [blame] | 216 | print(warn, file=sys.stderr) |
Kurt B. Kaiser | 1b6f398 | 2005-01-11 19:29:39 +0000 | [diff] [blame] | 217 | raise SystemExit |
Terry Jan Reedy | deb7bf1 | 2014-10-06 23:26:26 -0400 | [diff] [blame] | 218 | # TODO continue without userDIr instead of exit |
Steven M. Gava | 7cff66d | 2002-02-01 03:02:37 +0000 | [diff] [blame] | 219 | return userDir |
Kurt B. Kaiser | 6655e4b | 2002-12-31 16:03:23 +0000 | [diff] [blame] | 220 | |
Kurt B. Kaiser | 4d5bc60 | 2004-06-06 01:29:22 +0000 | [diff] [blame] | 221 | def GetOption(self, configType, section, option, default=None, type=None, |
Thomas Wouters | cf297e4 | 2007-02-23 15:07:44 +0000 | [diff] [blame] | 222 | warn_on_default=True, raw=False): |
Terry Jan Reedy | deb7bf1 | 2014-10-06 23:26:26 -0400 | [diff] [blame] | 223 | """Return a value for configType section option, or default. |
Kurt B. Kaiser | 4d5bc60 | 2004-06-06 01:29:22 +0000 | [diff] [blame] | 224 | |
Terry Jan Reedy | deb7bf1 | 2014-10-06 23:26:26 -0400 | [diff] [blame] | 225 | If type is not None, return a value of that type. Also pass raw |
| 226 | to the config parser. First try to return a valid value |
| 227 | (including type) from a user configuration. If that fails, try |
| 228 | the default configuration. If that fails, return default, with a |
| 229 | default of None. |
| 230 | |
| 231 | Warn if either user or default configurations have an invalid value. |
| 232 | Warn if default is returned and warn_on_default is True. |
Steven M. Gava | 429a86af | 2001-10-23 10:42:12 +0000 | [diff] [blame] | 233 | """ |
Andrew Svetlov | 8a495a4 | 2012-12-24 13:15:43 +0200 | [diff] [blame] | 234 | try: |
Terry Jan Reedy | deb7bf1 | 2014-10-06 23:26:26 -0400 | [diff] [blame] | 235 | if self.userCfg[configType].has_option(section, option): |
Andrew Svetlov | 8a495a4 | 2012-12-24 13:15:43 +0200 | [diff] [blame] | 236 | return self.userCfg[configType].Get(section, option, |
| 237 | type=type, raw=raw) |
| 238 | except ValueError: |
Terry Jan Reedy | 6fa5bdc | 2016-05-28 13:22:31 -0400 | [diff] [blame] | 239 | warning = ('\n Warning: config.py - IdleConf.GetOption -\n' |
Andrew Svetlov | 8a495a4 | 2012-12-24 13:15:43 +0200 | [diff] [blame] | 240 | ' invalid %r value for configuration option %r\n' |
Terry Jan Reedy | 81b062f | 2014-09-19 22:38:41 -0400 | [diff] [blame] | 241 | ' from section %r: %r' % |
Andrew Svetlov | 8a495a4 | 2012-12-24 13:15:43 +0200 | [diff] [blame] | 242 | (type, option, section, |
Terry Jan Reedy | deb7bf1 | 2014-10-06 23:26:26 -0400 | [diff] [blame] | 243 | self.userCfg[configType].Get(section, option, raw=raw))) |
Terry Jan Reedy | 9bdb1ed | 2016-07-10 13:46:34 -0400 | [diff] [blame] | 244 | _warn(warning, configType, section, option) |
Andrew Svetlov | 8a495a4 | 2012-12-24 13:15:43 +0200 | [diff] [blame] | 245 | try: |
| 246 | if self.defaultCfg[configType].has_option(section,option): |
Terry Jan Reedy | deb7bf1 | 2014-10-06 23:26:26 -0400 | [diff] [blame] | 247 | return self.defaultCfg[configType].Get( |
| 248 | section, option, type=type, raw=raw) |
Andrew Svetlov | 8a495a4 | 2012-12-24 13:15:43 +0200 | [diff] [blame] | 249 | except ValueError: |
| 250 | pass |
| 251 | #returning default, print warning |
| 252 | if warn_on_default: |
Terry Jan Reedy | 6fa5bdc | 2016-05-28 13:22:31 -0400 | [diff] [blame] | 253 | warning = ('\n Warning: config.py - IdleConf.GetOption -\n' |
Andrew Svetlov | 8a495a4 | 2012-12-24 13:15:43 +0200 | [diff] [blame] | 254 | ' problem retrieving configuration option %r\n' |
| 255 | ' from section %r.\n' |
Terry Jan Reedy | 81b062f | 2014-09-19 22:38:41 -0400 | [diff] [blame] | 256 | ' returning default value: %r' % |
Andrew Svetlov | 8a495a4 | 2012-12-24 13:15:43 +0200 | [diff] [blame] | 257 | (option, section, default)) |
Terry Jan Reedy | 9bdb1ed | 2016-07-10 13:46:34 -0400 | [diff] [blame] | 258 | _warn(warning, configType, section, option) |
Andrew Svetlov | 8a495a4 | 2012-12-24 13:15:43 +0200 | [diff] [blame] | 259 | return default |
Kurt B. Kaiser | 6655e4b | 2002-12-31 16:03:23 +0000 | [diff] [blame] | 260 | |
Kurt B. Kaiser | 4d5bc60 | 2004-06-06 01:29:22 +0000 | [diff] [blame] | 261 | def SetOption(self, configType, section, option, value): |
Terry Jan Reedy | deb7bf1 | 2014-10-06 23:26:26 -0400 | [diff] [blame] | 262 | """Set section option to value in user config file.""" |
Kurt B. Kaiser | 4d5bc60 | 2004-06-06 01:29:22 +0000 | [diff] [blame] | 263 | self.userCfg[configType].SetOption(section, option, value) |
| 264 | |
Steven M. Gava | 2a63a07 | 2001-10-26 06:50:54 +0000 | [diff] [blame] | 265 | def GetSectionList(self, configSet, configType): |
Terry Jan Reedy | deb7bf1 | 2014-10-06 23:26:26 -0400 | [diff] [blame] | 266 | """Return sections for configSet configType configuration. |
| 267 | |
Kurt B. Kaiser | 6655e4b | 2002-12-31 16:03:23 +0000 | [diff] [blame] | 268 | configSet must be either 'user' or 'default' |
Terry Jan Reedy | deb7bf1 | 2014-10-06 23:26:26 -0400 | [diff] [blame] | 269 | configType must be in self.config_types. |
Steven M. Gava | 2a63a07 | 2001-10-26 06:50:54 +0000 | [diff] [blame] | 270 | """ |
Terry Jan Reedy | deb7bf1 | 2014-10-06 23:26:26 -0400 | [diff] [blame] | 271 | if not (configType in self.config_types): |
Kurt B. Kaiser | ad66742 | 2007-08-23 01:06:15 +0000 | [diff] [blame] | 272 | raise InvalidConfigType('Invalid configType specified') |
Steven M. Gava | 2a63a07 | 2001-10-26 06:50:54 +0000 | [diff] [blame] | 273 | if configSet == 'user': |
Terry Jan Reedy | deb7bf1 | 2014-10-06 23:26:26 -0400 | [diff] [blame] | 274 | cfgParser = self.userCfg[configType] |
Steven M. Gava | 2a63a07 | 2001-10-26 06:50:54 +0000 | [diff] [blame] | 275 | elif configSet == 'default': |
| 276 | cfgParser=self.defaultCfg[configType] |
| 277 | else: |
Kurt B. Kaiser | ad66742 | 2007-08-23 01:06:15 +0000 | [diff] [blame] | 278 | raise InvalidConfigSet('Invalid configSet specified') |
Steven M. Gava | 2a63a07 | 2001-10-26 06:50:54 +0000 | [diff] [blame] | 279 | return cfgParser.sections() |
Kurt B. Kaiser | 6655e4b | 2002-12-31 16:03:23 +0000 | [diff] [blame] | 280 | |
Steven M. Gava | ad4f532 | 2002-01-03 12:05:17 +0000 | [diff] [blame] | 281 | def GetHighlight(self, theme, element, fgBg=None): |
Terry Jan Reedy | 8675799 | 2014-10-09 18:44:32 -0400 | [diff] [blame] | 282 | """Return individual theme element highlight color(s). |
Terry Jan Reedy | deb7bf1 | 2014-10-06 23:26:26 -0400 | [diff] [blame] | 283 | |
Terry Jan Reedy | 8675799 | 2014-10-09 18:44:32 -0400 | [diff] [blame] | 284 | fgBg - string ('fg' or 'bg') or None. |
| 285 | If None, return a dictionary containing fg and bg colors with |
| 286 | keys 'foreground' and 'background'. Otherwise, only return |
| 287 | fg or bg color, as specified. Colors are intended to be |
| 288 | appropriate for passing to Tkinter in, e.g., a tag_config call). |
Steven M. Gava | ad4f532 | 2002-01-03 12:05:17 +0000 | [diff] [blame] | 289 | """ |
Steven M. Gava | 9f25e67 | 2002-02-11 02:51:18 +0000 | [diff] [blame] | 290 | if self.defaultCfg['highlight'].has_section(theme): |
Terry Jan Reedy | deb7bf1 | 2014-10-06 23:26:26 -0400 | [diff] [blame] | 291 | themeDict = self.GetThemeDict('default', theme) |
Steven M. Gava | 9f25e67 | 2002-02-11 02:51:18 +0000 | [diff] [blame] | 292 | else: |
Terry Jan Reedy | deb7bf1 | 2014-10-06 23:26:26 -0400 | [diff] [blame] | 293 | themeDict = self.GetThemeDict('user', theme) |
| 294 | fore = themeDict[element + '-foreground'] |
Terry Jan Reedy | 8675799 | 2014-10-09 18:44:32 -0400 | [diff] [blame] | 295 | if element == 'cursor': # There is no config value for cursor bg |
Terry Jan Reedy | deb7bf1 | 2014-10-06 23:26:26 -0400 | [diff] [blame] | 296 | back = themeDict['normal-background'] |
Kurt B. Kaiser | 6655e4b | 2002-12-31 16:03:23 +0000 | [diff] [blame] | 297 | else: |
Terry Jan Reedy | deb7bf1 | 2014-10-06 23:26:26 -0400 | [diff] [blame] | 298 | back = themeDict[element + '-background'] |
| 299 | highlight = {"foreground": fore, "background": back} |
Terry Jan Reedy | 8675799 | 2014-10-09 18:44:32 -0400 | [diff] [blame] | 300 | if not fgBg: # Return dict of both colors |
Steven M. Gava | ad4f532 | 2002-01-03 12:05:17 +0000 | [diff] [blame] | 301 | return highlight |
Terry Jan Reedy | 8675799 | 2014-10-09 18:44:32 -0400 | [diff] [blame] | 302 | else: # Return specified color only |
Steven M. Gava | ad4f532 | 2002-01-03 12:05:17 +0000 | [diff] [blame] | 303 | if fgBg == 'fg': |
| 304 | return highlight["foreground"] |
| 305 | if fgBg == 'bg': |
| 306 | return highlight["background"] |
Kurt B. Kaiser | 6655e4b | 2002-12-31 16:03:23 +0000 | [diff] [blame] | 307 | else: |
Kurt B. Kaiser | ad66742 | 2007-08-23 01:06:15 +0000 | [diff] [blame] | 308 | raise InvalidFgBg('Invalid fgBg specified') |
Steven M. Gava | 9f25e67 | 2002-02-11 02:51:18 +0000 | [diff] [blame] | 309 | |
Terry Jan Reedy | deb7bf1 | 2014-10-06 23:26:26 -0400 | [diff] [blame] | 310 | def GetThemeDict(self, type, themeName): |
| 311 | """Return {option:value} dict for elements in themeName. |
| 312 | |
Steven M. Gava | f9bb90e | 2002-01-24 06:02:50 +0000 | [diff] [blame] | 313 | type - string, 'default' or 'user' theme type |
| 314 | themeName - string, theme name |
Terry Jan Reedy | deb7bf1 | 2014-10-06 23:26:26 -0400 | [diff] [blame] | 315 | Values are loaded over ultimate fallback defaults to guarantee |
| 316 | that all theme elements are present in a newly created theme. |
Steven M. Gava | 2a63a07 | 2001-10-26 06:50:54 +0000 | [diff] [blame] | 317 | """ |
Steven M. Gava | f9bb90e | 2002-01-24 06:02:50 +0000 | [diff] [blame] | 318 | if type == 'user': |
Terry Jan Reedy | deb7bf1 | 2014-10-06 23:26:26 -0400 | [diff] [blame] | 319 | cfgParser = self.userCfg['highlight'] |
Steven M. Gava | f9bb90e | 2002-01-24 06:02:50 +0000 | [diff] [blame] | 320 | elif type == 'default': |
Terry Jan Reedy | deb7bf1 | 2014-10-06 23:26:26 -0400 | [diff] [blame] | 321 | cfgParser = self.defaultCfg['highlight'] |
Steven M. Gava | f9bb90e | 2002-01-24 06:02:50 +0000 | [diff] [blame] | 322 | else: |
Kurt B. Kaiser | ad66742 | 2007-08-23 01:06:15 +0000 | [diff] [blame] | 323 | raise InvalidTheme('Invalid theme type specified') |
Terry Jan Reedy | 8675799 | 2014-10-09 18:44:32 -0400 | [diff] [blame] | 324 | # Provide foreground and background colors for each theme |
| 325 | # element (other than cursor) even though some values are not |
| 326 | # yet used by idle, to allow for their use in the future. |
| 327 | # Default values are generally black and white. |
| 328 | # TODO copy theme from a class attribute. |
Terry Jan Reedy | deb7bf1 | 2014-10-06 23:26:26 -0400 | [diff] [blame] | 329 | theme ={'normal-foreground':'#000000', |
Kurt B. Kaiser | 6655e4b | 2002-12-31 16:03:23 +0000 | [diff] [blame] | 330 | 'normal-background':'#ffffff', |
| 331 | 'keyword-foreground':'#000000', |
| 332 | 'keyword-background':'#ffffff', |
Kurt B. Kaiser | 73360a3 | 2004-03-08 18:15:31 +0000 | [diff] [blame] | 333 | 'builtin-foreground':'#000000', |
| 334 | 'builtin-background':'#ffffff', |
Kurt B. Kaiser | 6655e4b | 2002-12-31 16:03:23 +0000 | [diff] [blame] | 335 | 'comment-foreground':'#000000', |
| 336 | 'comment-background':'#ffffff', |
Steven M. Gava | f9bb90e | 2002-01-24 06:02:50 +0000 | [diff] [blame] | 337 | 'string-foreground':'#000000', |
| 338 | 'string-background':'#ffffff', |
Kurt B. Kaiser | 6655e4b | 2002-12-31 16:03:23 +0000 | [diff] [blame] | 339 | 'definition-foreground':'#000000', |
Steven M. Gava | f9bb90e | 2002-01-24 06:02:50 +0000 | [diff] [blame] | 340 | 'definition-background':'#ffffff', |
| 341 | 'hilite-foreground':'#000000', |
| 342 | 'hilite-background':'gray', |
| 343 | 'break-foreground':'#ffffff', |
| 344 | 'break-background':'#000000', |
| 345 | 'hit-foreground':'#ffffff', |
| 346 | 'hit-background':'#000000', |
| 347 | 'error-foreground':'#ffffff', |
Kurt B. Kaiser | 6655e4b | 2002-12-31 16:03:23 +0000 | [diff] [blame] | 348 | 'error-background':'#000000', |
| 349 | #cursor (only foreground can be set) |
| 350 | 'cursor-foreground':'#000000', |
Steven M. Gava | f9bb90e | 2002-01-24 06:02:50 +0000 | [diff] [blame] | 351 | #shell window |
| 352 | 'stdout-foreground':'#000000', |
| 353 | 'stdout-background':'#ffffff', |
| 354 | 'stderr-foreground':'#000000', |
| 355 | 'stderr-background':'#ffffff', |
| 356 | 'console-foreground':'#000000', |
| 357 | 'console-background':'#ffffff' } |
Kurt B. Kaiser | e071277 | 2007-08-23 05:25:55 +0000 | [diff] [blame] | 358 | for element in theme: |
Terry Jan Reedy | deb7bf1 | 2014-10-06 23:26:26 -0400 | [diff] [blame] | 359 | if not cfgParser.has_option(themeName, element): |
Terry Jan Reedy | 8675799 | 2014-10-09 18:44:32 -0400 | [diff] [blame] | 360 | # Print warning that will return a default color |
Terry Jan Reedy | 6fa5bdc | 2016-05-28 13:22:31 -0400 | [diff] [blame] | 361 | warning = ('\n Warning: config.IdleConf.GetThemeDict' |
Walter Dörwald | 70a6b49 | 2004-02-12 17:35:32 +0000 | [diff] [blame] | 362 | ' -\n problem retrieving theme element %r' |
| 363 | '\n from theme %r.\n' |
Terry Jan Reedy | 8675799 | 2014-10-09 18:44:32 -0400 | [diff] [blame] | 364 | ' returning default color: %r' % |
Walter Dörwald | 70a6b49 | 2004-02-12 17:35:32 +0000 | [diff] [blame] | 365 | (element, themeName, theme[element])) |
Terry Jan Reedy | 9bdb1ed | 2016-07-10 13:46:34 -0400 | [diff] [blame] | 366 | _warn(warning, 'highlight', themeName, element) |
Terry Jan Reedy | 8675799 | 2014-10-09 18:44:32 -0400 | [diff] [blame] | 367 | theme[element] = cfgParser.Get( |
| 368 | themeName, element, default=theme[element]) |
Steven M. Gava | f9bb90e | 2002-01-24 06:02:50 +0000 | [diff] [blame] | 369 | return theme |
Kurt B. Kaiser | 6655e4b | 2002-12-31 16:03:23 +0000 | [diff] [blame] | 370 | |
Steven M. Gava | ad4f532 | 2002-01-03 12:05:17 +0000 | [diff] [blame] | 371 | def CurrentTheme(self): |
Terry Jan Reedy | 9bdb1ed | 2016-07-10 13:46:34 -0400 | [diff] [blame] | 372 | "Return the name of the currently active text color theme." |
| 373 | return self.current_colors_and_keys('Theme') |
Terry Jan Reedy | d0c0f00 | 2015-11-12 15:02:57 -0500 | [diff] [blame] | 374 | |
Terry Jan Reedy | 9bdb1ed | 2016-07-10 13:46:34 -0400 | [diff] [blame] | 375 | def CurrentKeys(self): |
| 376 | """Return the name of the currently active key set.""" |
| 377 | return self.current_colors_and_keys('Keys') |
| 378 | |
| 379 | def current_colors_and_keys(self, section): |
| 380 | """Return the currently active name for Theme or Keys section. |
| 381 | |
| 382 | idlelib.config-main.def ('default') includes these sections |
| 383 | |
Terry Jan Reedy | d0c0f00 | 2015-11-12 15:02:57 -0500 | [diff] [blame] | 384 | [Theme] |
| 385 | default= 1 |
| 386 | name= IDLE Classic |
| 387 | name2= |
Terry Jan Reedy | d0c0f00 | 2015-11-12 15:02:57 -0500 | [diff] [blame] | 388 | |
Terry Jan Reedy | 9bdb1ed | 2016-07-10 13:46:34 -0400 | [diff] [blame] | 389 | [Keys] |
| 390 | default= 1 |
| 391 | name= |
| 392 | name2= |
| 393 | |
| 394 | Item 'name2', is used for built-in ('default') themes and keys |
| 395 | added after 2015 Oct 1 and 2016 July 1. This kludge is needed |
| 396 | because setting 'name' to a builtin not defined in older IDLEs |
| 397 | to display multiple error messages or quit. |
Terry Jan Reedy | d0c0f00 | 2015-11-12 15:02:57 -0500 | [diff] [blame] | 398 | See https://bugs.python.org/issue25313. |
Terry Jan Reedy | 9bdb1ed | 2016-07-10 13:46:34 -0400 | [diff] [blame] | 399 | When default = True, 'name2' takes precedence over 'name', |
| 400 | while older IDLEs will just use name. When default = False, |
| 401 | 'name2' may still be set, but it is ignored. |
Terry Jan Reedy | d0c0f00 | 2015-11-12 15:02:57 -0500 | [diff] [blame] | 402 | """ |
Terry Jan Reedy | 9bdb1ed | 2016-07-10 13:46:34 -0400 | [diff] [blame] | 403 | cfgname = 'highlight' if section == 'Theme' else 'keys' |
Terry Jan Reedy | 5acf4e5 | 2016-08-24 22:08:01 -0400 | [diff] [blame] | 404 | default = self.GetOption('main', section, 'default', |
Terry Jan Reedy | d0c0f00 | 2015-11-12 15:02:57 -0500 | [diff] [blame] | 405 | type='bool', default=True) |
Terry Jan Reedy | 9bdb1ed | 2016-07-10 13:46:34 -0400 | [diff] [blame] | 406 | name = '' |
Terry Jan Reedy | d0c0f00 | 2015-11-12 15:02:57 -0500 | [diff] [blame] | 407 | if default: |
Terry Jan Reedy | 9bdb1ed | 2016-07-10 13:46:34 -0400 | [diff] [blame] | 408 | name = self.GetOption('main', section, 'name2', default='') |
| 409 | if not name: |
| 410 | name = self.GetOption('main', section, 'name', default='') |
| 411 | if name: |
| 412 | source = self.defaultCfg if default else self.userCfg |
| 413 | if source[cfgname].has_section(name): |
| 414 | return name |
| 415 | return "IDLE Classic" if section == 'Theme' else self.default_keys() |
| 416 | |
| 417 | @staticmethod |
| 418 | def default_keys(): |
| 419 | if sys.platform[:3] == 'win': |
| 420 | return 'IDLE Classic Windows' |
| 421 | elif sys.platform == 'darwin': |
| 422 | return 'IDLE Classic OSX' |
Terry Jan Reedy | c15a7c6 | 2015-11-12 15:06:07 -0500 | [diff] [blame] | 423 | else: |
Terry Jan Reedy | 9bdb1ed | 2016-07-10 13:46:34 -0400 | [diff] [blame] | 424 | return 'IDLE Modern Unix' |
Kurt B. Kaiser | 6655e4b | 2002-12-31 16:03:23 +0000 | [diff] [blame] | 425 | |
Terry Jan Reedy | 9bdb1ed | 2016-07-10 13:46:34 -0400 | [diff] [blame] | 426 | def GetExtensions(self, active_only=True, |
| 427 | editor_only=False, shell_only=False): |
Terry Jan Reedy | deb7bf1 | 2014-10-06 23:26:26 -0400 | [diff] [blame] | 428 | """Return extensions in default and user config-extensions files. |
| 429 | |
| 430 | If active_only True, only return active (enabled) extensions |
| 431 | and optionally only editor or shell extensions. |
| 432 | If active_only False, return all extensions. |
Steven M. Gava | ad4f532 | 2002-01-03 12:05:17 +0000 | [diff] [blame] | 433 | """ |
Terry Jan Reedy | deb7bf1 | 2014-10-06 23:26:26 -0400 | [diff] [blame] | 434 | extns = self.RemoveKeyBindNames( |
| 435 | self.GetSectionList('default', 'extensions')) |
| 436 | userExtns = self.RemoveKeyBindNames( |
| 437 | self.GetSectionList('user', 'extensions')) |
Steven M. Gava | ad4f532 | 2002-01-03 12:05:17 +0000 | [diff] [blame] | 438 | for extn in userExtns: |
| 439 | if extn not in extns: #user has added own extension |
Kurt B. Kaiser | 6655e4b | 2002-12-31 16:03:23 +0000 | [diff] [blame] | 440 | extns.append(extn) |
Kurt B. Kaiser | 4d5bc60 | 2004-06-06 01:29:22 +0000 | [diff] [blame] | 441 | if active_only: |
Terry Jan Reedy | deb7bf1 | 2014-10-06 23:26:26 -0400 | [diff] [blame] | 442 | activeExtns = [] |
Steven M. Gava | ad4f532 | 2002-01-03 12:05:17 +0000 | [diff] [blame] | 443 | for extn in extns: |
Kurt B. Kaiser | 4d5bc60 | 2004-06-06 01:29:22 +0000 | [diff] [blame] | 444 | if self.GetOption('extensions', extn, 'enable', default=True, |
| 445 | type='bool'): |
Steven M. Gava | ad4f532 | 2002-01-03 12:05:17 +0000 | [diff] [blame] | 446 | #the extension is enabled |
Terry Jan Reedy | 9bdb1ed | 2016-07-10 13:46:34 -0400 | [diff] [blame] | 447 | if editor_only or shell_only: # TODO both True contradict |
Kurt B. Kaiser | 4d5bc60 | 2004-06-06 01:29:22 +0000 | [diff] [blame] | 448 | if editor_only: |
| 449 | option = "enable_editor" |
| 450 | else: |
| 451 | option = "enable_shell" |
| 452 | if self.GetOption('extensions', extn,option, |
| 453 | default=True, type='bool', |
| 454 | warn_on_default=False): |
| 455 | activeExtns.append(extn) |
| 456 | else: |
| 457 | activeExtns.append(extn) |
Steven M. Gava | ad4f532 | 2002-01-03 12:05:17 +0000 | [diff] [blame] | 458 | return activeExtns |
| 459 | else: |
Kurt B. Kaiser | 6655e4b | 2002-12-31 16:03:23 +0000 | [diff] [blame] | 460 | return extns |
Steven M. Gava | ad4f532 | 2002-01-03 12:05:17 +0000 | [diff] [blame] | 461 | |
Terry Jan Reedy | deb7bf1 | 2014-10-06 23:26:26 -0400 | [diff] [blame] | 462 | def RemoveKeyBindNames(self, extnNameList): |
| 463 | "Return extnNameList with keybinding section names removed." |
| 464 | # TODO Easier to return filtered copy with list comp |
| 465 | names = extnNameList |
| 466 | kbNameIndicies = [] |
Steven M. Gava | c628a06 | 2002-01-19 10:33:21 +0000 | [diff] [blame] | 467 | for name in names: |
Thomas Wouters | 0e3f591 | 2006-08-11 14:57:12 +0000 | [diff] [blame] | 468 | if name.endswith(('_bindings', '_cfgBindings')): |
Kurt B. Kaiser | 6655e4b | 2002-12-31 16:03:23 +0000 | [diff] [blame] | 469 | kbNameIndicies.append(names.index(name)) |
Terry Jan Reedy | deb7bf1 | 2014-10-06 23:26:26 -0400 | [diff] [blame] | 470 | kbNameIndicies.sort(reverse=True) |
Kurt B. Kaiser | 6655e4b | 2002-12-31 16:03:23 +0000 | [diff] [blame] | 471 | for index in kbNameIndicies: #delete each keybinding section name |
Steven M. Gava | c628a06 | 2002-01-19 10:33:21 +0000 | [diff] [blame] | 472 | del(names[index]) |
| 473 | return names |
Kurt B. Kaiser | 6655e4b | 2002-12-31 16:03:23 +0000 | [diff] [blame] | 474 | |
Terry Jan Reedy | deb7bf1 | 2014-10-06 23:26:26 -0400 | [diff] [blame] | 475 | def GetExtnNameForEvent(self, virtualEvent): |
| 476 | """Return the name of the extension binding virtualEvent, or None. |
| 477 | |
| 478 | virtualEvent - string, name of the virtual event to test for, |
| 479 | without the enclosing '<< >>' |
Steven M. Gava | a498af2 | 2002-02-01 01:33:36 +0000 | [diff] [blame] | 480 | """ |
Terry Jan Reedy | deb7bf1 | 2014-10-06 23:26:26 -0400 | [diff] [blame] | 481 | extName = None |
| 482 | vEvent = '<<' + virtualEvent + '>>' |
Kurt B. Kaiser | 4d5bc60 | 2004-06-06 01:29:22 +0000 | [diff] [blame] | 483 | for extn in self.GetExtensions(active_only=0): |
Kurt B. Kaiser | e071277 | 2007-08-23 05:25:55 +0000 | [diff] [blame] | 484 | for event in self.GetExtensionKeys(extn): |
Steven M. Gava | a498af2 | 2002-02-01 01:33:36 +0000 | [diff] [blame] | 485 | if event == vEvent: |
Terry Jan Reedy | deb7bf1 | 2014-10-06 23:26:26 -0400 | [diff] [blame] | 486 | extName = extn # TODO return here? |
Steven M. Gava | a498af2 | 2002-02-01 01:33:36 +0000 | [diff] [blame] | 487 | return extName |
Kurt B. Kaiser | 6655e4b | 2002-12-31 16:03:23 +0000 | [diff] [blame] | 488 | |
Terry Jan Reedy | deb7bf1 | 2014-10-06 23:26:26 -0400 | [diff] [blame] | 489 | def GetExtensionKeys(self, extensionName): |
| 490 | """Return dict: {configurable extensionName event : active keybinding}. |
| 491 | |
| 492 | Events come from default config extension_cfgBindings section. |
| 493 | Keybindings come from GetCurrentKeySet() active key dict, |
| 494 | where previously used bindings are disabled. |
Steven M. Gava | c628a06 | 2002-01-19 10:33:21 +0000 | [diff] [blame] | 495 | """ |
Terry Jan Reedy | deb7bf1 | 2014-10-06 23:26:26 -0400 | [diff] [blame] | 496 | keysName = extensionName + '_cfgBindings' |
| 497 | activeKeys = self.GetCurrentKeySet() |
| 498 | extKeys = {} |
Steven M. Gava | c628a06 | 2002-01-19 10:33:21 +0000 | [diff] [blame] | 499 | if self.defaultCfg['extensions'].has_section(keysName): |
Terry Jan Reedy | deb7bf1 | 2014-10-06 23:26:26 -0400 | [diff] [blame] | 500 | eventNames = self.defaultCfg['extensions'].GetOptionList(keysName) |
Steven M. Gava | c628a06 | 2002-01-19 10:33:21 +0000 | [diff] [blame] | 501 | for eventName in eventNames: |
Terry Jan Reedy | deb7bf1 | 2014-10-06 23:26:26 -0400 | [diff] [blame] | 502 | event = '<<' + eventName + '>>' |
| 503 | binding = activeKeys[event] |
| 504 | extKeys[event] = binding |
Kurt B. Kaiser | 6655e4b | 2002-12-31 16:03:23 +0000 | [diff] [blame] | 505 | return extKeys |
| 506 | |
Steven M. Gava | c628a06 | 2002-01-19 10:33:21 +0000 | [diff] [blame] | 507 | def __GetRawExtensionKeys(self,extensionName): |
Terry Jan Reedy | deb7bf1 | 2014-10-06 23:26:26 -0400 | [diff] [blame] | 508 | """Return dict {configurable extensionName event : keybinding list}. |
| 509 | |
| 510 | Events come from default config extension_cfgBindings section. |
| 511 | Keybindings list come from the splitting of GetOption, which |
| 512 | tries user config before default config. |
Steven M. Gava | c628a06 | 2002-01-19 10:33:21 +0000 | [diff] [blame] | 513 | """ |
Terry Jan Reedy | deb7bf1 | 2014-10-06 23:26:26 -0400 | [diff] [blame] | 514 | keysName = extensionName+'_cfgBindings' |
| 515 | extKeys = {} |
Steven M. Gava | c628a06 | 2002-01-19 10:33:21 +0000 | [diff] [blame] | 516 | if self.defaultCfg['extensions'].has_section(keysName): |
Terry Jan Reedy | deb7bf1 | 2014-10-06 23:26:26 -0400 | [diff] [blame] | 517 | eventNames = self.defaultCfg['extensions'].GetOptionList(keysName) |
Steven M. Gava | c628a06 | 2002-01-19 10:33:21 +0000 | [diff] [blame] | 518 | for eventName in eventNames: |
Terry Jan Reedy | deb7bf1 | 2014-10-06 23:26:26 -0400 | [diff] [blame] | 519 | binding = self.GetOption( |
| 520 | 'extensions', keysName, eventName, default='').split() |
| 521 | event = '<<' + eventName + '>>' |
| 522 | extKeys[event] = binding |
Kurt B. Kaiser | 6655e4b | 2002-12-31 16:03:23 +0000 | [diff] [blame] | 523 | return extKeys |
| 524 | |
Terry Jan Reedy | deb7bf1 | 2014-10-06 23:26:26 -0400 | [diff] [blame] | 525 | def GetExtensionBindings(self, extensionName): |
| 526 | """Return dict {extensionName event : active or defined keybinding}. |
| 527 | |
| 528 | Augment self.GetExtensionKeys(extensionName) with mapping of non- |
| 529 | configurable events (from default config) to GetOption splits, |
| 530 | as in self.__GetRawExtensionKeys. |
Steven M. Gava | c628a06 | 2002-01-19 10:33:21 +0000 | [diff] [blame] | 531 | """ |
Terry Jan Reedy | deb7bf1 | 2014-10-06 23:26:26 -0400 | [diff] [blame] | 532 | bindsName = extensionName + '_bindings' |
| 533 | extBinds = self.GetExtensionKeys(extensionName) |
Steven M. Gava | c628a06 | 2002-01-19 10:33:21 +0000 | [diff] [blame] | 534 | #add the non-configurable bindings |
| 535 | if self.defaultCfg['extensions'].has_section(bindsName): |
Terry Jan Reedy | deb7bf1 | 2014-10-06 23:26:26 -0400 | [diff] [blame] | 536 | eventNames = self.defaultCfg['extensions'].GetOptionList(bindsName) |
Steven M. Gava | c628a06 | 2002-01-19 10:33:21 +0000 | [diff] [blame] | 537 | for eventName in eventNames: |
Terry Jan Reedy | deb7bf1 | 2014-10-06 23:26:26 -0400 | [diff] [blame] | 538 | binding = self.GetOption( |
| 539 | 'extensions', bindsName, eventName, default='').split() |
| 540 | event = '<<' + eventName + '>>' |
| 541 | extBinds[event] = binding |
Kurt B. Kaiser | 6655e4b | 2002-12-31 16:03:23 +0000 | [diff] [blame] | 542 | |
| 543 | return extBinds |
| 544 | |
Steven M. Gava | 0cae01c | 2002-01-04 07:53:06 +0000 | [diff] [blame] | 545 | def GetKeyBinding(self, keySetName, eventStr): |
Terry Jan Reedy | deb7bf1 | 2014-10-06 23:26:26 -0400 | [diff] [blame] | 546 | """Return the keybinding list for keySetName eventStr. |
| 547 | |
| 548 | keySetName - name of key binding set (config-keys section). |
| 549 | eventStr - virtual event, including brackets, as in '<<event>>'. |
Steven M. Gava | 0cae01c | 2002-01-04 07:53:06 +0000 | [diff] [blame] | 550 | """ |
Terry Jan Reedy | deb7bf1 | 2014-10-06 23:26:26 -0400 | [diff] [blame] | 551 | eventName = eventStr[2:-2] #trim off the angle brackets |
Terry Jan Reedy | 9bdb1ed | 2016-07-10 13:46:34 -0400 | [diff] [blame] | 552 | binding = self.GetOption('keys', keySetName, eventName, default='', |
| 553 | warn_on_default=False).split() |
Steven M. Gava | 0cae01c | 2002-01-04 07:53:06 +0000 | [diff] [blame] | 554 | return binding |
| 555 | |
Steven M. Gava | c628a06 | 2002-01-19 10:33:21 +0000 | [diff] [blame] | 556 | def GetCurrentKeySet(self): |
Terry Jan Reedy | deb7bf1 | 2014-10-06 23:26:26 -0400 | [diff] [blame] | 557 | "Return CurrentKeys with 'darwin' modifications." |
Thomas Wouters | 0e3f591 | 2006-08-11 14:57:12 +0000 | [diff] [blame] | 558 | result = self.GetKeySet(self.CurrentKeys()) |
| 559 | |
Ned Deily | b760167 | 2014-03-27 20:49:14 -0700 | [diff] [blame] | 560 | if sys.platform == "darwin": |
| 561 | # OS X Tk variants do not support the "Alt" keyboard modifier. |
| 562 | # So replace all keybingings that use "Alt" with ones that |
| 563 | # use the "Option" keyboard modifier. |
Terry Jan Reedy | deb7bf1 | 2014-10-06 23:26:26 -0400 | [diff] [blame] | 564 | # TODO (Ned?): the "Option" modifier does not work properly for |
Ned Deily | b760167 | 2014-03-27 20:49:14 -0700 | [diff] [blame] | 565 | # Cocoa Tk and XQuartz Tk so we should not use it |
| 566 | # in default OS X KeySets. |
Thomas Wouters | 0e3f591 | 2006-08-11 14:57:12 +0000 | [diff] [blame] | 567 | for k, v in result.items(): |
| 568 | v2 = [ x.replace('<Alt-', '<Option-') for x in v ] |
| 569 | if v != v2: |
| 570 | result[k] = v2 |
| 571 | |
| 572 | return result |
Kurt B. Kaiser | 6655e4b | 2002-12-31 16:03:23 +0000 | [diff] [blame] | 573 | |
Terry Jan Reedy | deb7bf1 | 2014-10-06 23:26:26 -0400 | [diff] [blame] | 574 | def GetKeySet(self, keySetName): |
| 575 | """Return event-key dict for keySetName core plus active extensions. |
| 576 | |
| 577 | If a binding defined in an extension is already in use, the |
| 578 | extension binding is disabled by being set to '' |
Steven M. Gava | 2a63a07 | 2001-10-26 06:50:54 +0000 | [diff] [blame] | 579 | """ |
Terry Jan Reedy | deb7bf1 | 2014-10-06 23:26:26 -0400 | [diff] [blame] | 580 | keySet = self.GetCoreKeys(keySetName) |
| 581 | activeExtns = self.GetExtensions(active_only=1) |
Steven M. Gava | c628a06 | 2002-01-19 10:33:21 +0000 | [diff] [blame] | 582 | for extn in activeExtns: |
Terry Jan Reedy | deb7bf1 | 2014-10-06 23:26:26 -0400 | [diff] [blame] | 583 | extKeys = self.__GetRawExtensionKeys(extn) |
Steven M. Gava | c628a06 | 2002-01-19 10:33:21 +0000 | [diff] [blame] | 584 | if extKeys: #the extension defines keybindings |
Kurt B. Kaiser | e071277 | 2007-08-23 05:25:55 +0000 | [diff] [blame] | 585 | for event in extKeys: |
Steven M. Gava | f9bb90e | 2002-01-24 06:02:50 +0000 | [diff] [blame] | 586 | if extKeys[event] in keySet.values(): |
Steven M. Gava | c628a06 | 2002-01-19 10:33:21 +0000 | [diff] [blame] | 587 | #the binding is already in use |
Terry Jan Reedy | deb7bf1 | 2014-10-06 23:26:26 -0400 | [diff] [blame] | 588 | extKeys[event] = '' #disable this binding |
| 589 | keySet[event] = extKeys[event] #add binding |
Steven M. Gava | f9bb90e | 2002-01-24 06:02:50 +0000 | [diff] [blame] | 590 | return keySet |
| 591 | |
Terry Jan Reedy | deb7bf1 | 2014-10-06 23:26:26 -0400 | [diff] [blame] | 592 | def IsCoreBinding(self, virtualEvent): |
| 593 | """Return True if the virtual event is one of the core idle key events. |
| 594 | |
| 595 | virtualEvent - string, name of the virtual event to test for, |
| 596 | without the enclosing '<< >>' |
Steven M. Gava | a498af2 | 2002-02-01 01:33:36 +0000 | [diff] [blame] | 597 | """ |
Kurt B. Kaiser | e071277 | 2007-08-23 05:25:55 +0000 | [diff] [blame] | 598 | return ('<<'+virtualEvent+'>>') in self.GetCoreKeys() |
Kurt B. Kaiser | 6655e4b | 2002-12-31 16:03:23 +0000 | [diff] [blame] | 599 | |
Terry Jan Reedy | deb7bf1 | 2014-10-06 23:26:26 -0400 | [diff] [blame] | 600 | # TODO make keyBindins a file or class attribute used for test above |
| 601 | # and copied in function below |
| 602 | |
Steven M. Gava | c628a06 | 2002-01-19 10:33:21 +0000 | [diff] [blame] | 603 | def GetCoreKeys(self, keySetName=None): |
Terry Jan Reedy | deb7bf1 | 2014-10-06 23:26:26 -0400 | [diff] [blame] | 604 | """Return dict of core virtual-key keybindings for keySetName. |
| 605 | |
| 606 | The default keySetName None corresponds to the keyBindings base |
| 607 | dict. If keySetName is not None, bindings from the config |
| 608 | file(s) are loaded _over_ these defaults, so if there is a |
| 609 | problem getting any core binding there will be an 'ultimate last |
| 610 | resort fallback' to the CUA-ish bindings defined here. |
Steven M. Gava | 2a63a07 | 2001-10-26 06:50:54 +0000 | [diff] [blame] | 611 | """ |
Steven M. Gava | 17d0154 | 2001-12-03 00:37:28 +0000 | [diff] [blame] | 612 | keyBindings={ |
Steven M. Gava | a498af2 | 2002-02-01 01:33:36 +0000 | [diff] [blame] | 613 | '<<copy>>': ['<Control-c>', '<Control-C>'], |
| 614 | '<<cut>>': ['<Control-x>', '<Control-X>'], |
| 615 | '<<paste>>': ['<Control-v>', '<Control-V>'], |
Steven M. Gava | 17d0154 | 2001-12-03 00:37:28 +0000 | [diff] [blame] | 616 | '<<beginning-of-line>>': ['<Control-a>', '<Home>'], |
| 617 | '<<center-insert>>': ['<Control-l>'], |
| 618 | '<<close-all-windows>>': ['<Control-q>'], |
| 619 | '<<close-window>>': ['<Alt-F4>'], |
Kurt B. Kaiser | 84f4803 | 2002-09-26 22:13:22 +0000 | [diff] [blame] | 620 | '<<do-nothing>>': ['<Control-x>'], |
Steven M. Gava | 17d0154 | 2001-12-03 00:37:28 +0000 | [diff] [blame] | 621 | '<<end-of-file>>': ['<Control-d>'], |
| 622 | '<<python-docs>>': ['<F1>'], |
Kurt B. Kaiser | 6655e4b | 2002-12-31 16:03:23 +0000 | [diff] [blame] | 623 | '<<python-context-help>>': ['<Shift-F1>'], |
Steven M. Gava | 17d0154 | 2001-12-03 00:37:28 +0000 | [diff] [blame] | 624 | '<<history-next>>': ['<Alt-n>'], |
| 625 | '<<history-previous>>': ['<Alt-p>'], |
| 626 | '<<interrupt-execution>>': ['<Control-c>'], |
Kurt B. Kaiser | 1061e72 | 2003-01-04 01:43:53 +0000 | [diff] [blame] | 627 | '<<view-restart>>': ['<F6>'], |
Kurt B. Kaiser | 4cc5ef5 | 2003-01-22 00:23:23 +0000 | [diff] [blame] | 628 | '<<restart-shell>>': ['<Control-F6>'], |
Steven M. Gava | 17d0154 | 2001-12-03 00:37:28 +0000 | [diff] [blame] | 629 | '<<open-class-browser>>': ['<Alt-c>'], |
| 630 | '<<open-module>>': ['<Alt-m>'], |
| 631 | '<<open-new-window>>': ['<Control-n>'], |
| 632 | '<<open-window-from-file>>': ['<Control-o>'], |
| 633 | '<<plain-newline-and-indent>>': ['<Control-j>'], |
Steven M. Gava | 7981ce5 | 2002-06-11 04:45:34 +0000 | [diff] [blame] | 634 | '<<print-window>>': ['<Control-p>'], |
Steven M. Gava | 17d0154 | 2001-12-03 00:37:28 +0000 | [diff] [blame] | 635 | '<<redo>>': ['<Control-y>'], |
| 636 | '<<remove-selection>>': ['<Escape>'], |
Kurt B. Kaiser | 2303b1c | 2003-11-24 05:26:16 +0000 | [diff] [blame] | 637 | '<<save-copy-of-window-as-file>>': ['<Alt-Shift-S>'], |
Steven M. Gava | 17d0154 | 2001-12-03 00:37:28 +0000 | [diff] [blame] | 638 | '<<save-window-as-file>>': ['<Alt-s>'], |
| 639 | '<<save-window>>': ['<Control-s>'], |
| 640 | '<<select-all>>': ['<Alt-a>'], |
| 641 | '<<toggle-auto-coloring>>': ['<Control-slash>'], |
Steven M. Gava | 0cae01c | 2002-01-04 07:53:06 +0000 | [diff] [blame] | 642 | '<<undo>>': ['<Control-z>'], |
| 643 | '<<find-again>>': ['<Control-g>', '<F3>'], |
| 644 | '<<find-in-files>>': ['<Alt-F3>'], |
| 645 | '<<find-selection>>': ['<Control-F3>'], |
| 646 | '<<find>>': ['<Control-f>'], |
| 647 | '<<replace>>': ['<Control-h>'], |
Kurt B. Kaiser | 6655e4b | 2002-12-31 16:03:23 +0000 | [diff] [blame] | 648 | '<<goto-line>>': ['<Alt-g>'], |
Kurt B. Kaiser | a9f8cbc | 2002-09-14 03:17:01 +0000 | [diff] [blame] | 649 | '<<smart-backspace>>': ['<Key-BackSpace>'], |
Andrew Svetlov | 67ac079 | 2012-03-29 19:01:28 +0300 | [diff] [blame] | 650 | '<<newline-and-indent>>': ['<Key-Return>', '<Key-KP_Enter>'], |
Kurt B. Kaiser | a9f8cbc | 2002-09-14 03:17:01 +0000 | [diff] [blame] | 651 | '<<smart-indent>>': ['<Key-Tab>'], |
| 652 | '<<indent-region>>': ['<Control-Key-bracketright>'], |
| 653 | '<<dedent-region>>': ['<Control-Key-bracketleft>'], |
| 654 | '<<comment-region>>': ['<Alt-Key-3>'], |
| 655 | '<<uncomment-region>>': ['<Alt-Key-4>'], |
| 656 | '<<tabify-region>>': ['<Alt-Key-5>'], |
| 657 | '<<untabify-region>>': ['<Alt-Key-6>'], |
| 658 | '<<toggle-tabs>>': ['<Alt-Key-t>'], |
Kurt B. Kaiser | 3069dbb | 2005-01-28 00:16:16 +0000 | [diff] [blame] | 659 | '<<change-indentwidth>>': ['<Alt-Key-u>'], |
| 660 | '<<del-word-left>>': ['<Control-Key-BackSpace>'], |
| 661 | '<<del-word-right>>': ['<Control-Key-Delete>'] |
Kurt B. Kaiser | a9f8cbc | 2002-09-14 03:17:01 +0000 | [diff] [blame] | 662 | } |
Steven M. Gava | 17d0154 | 2001-12-03 00:37:28 +0000 | [diff] [blame] | 663 | if keySetName: |
Terry Jan Reedy | 9bdb1ed | 2016-07-10 13:46:34 -0400 | [diff] [blame] | 664 | if not (self.userCfg['keys'].has_section(keySetName) or |
| 665 | self.defaultCfg['keys'].has_section(keySetName)): |
| 666 | warning = ( |
| 667 | '\n Warning: config.py - IdleConf.GetCoreKeys -\n' |
| 668 | ' key set %r is not defined, using default bindings.' % |
| 669 | (keySetName,) |
| 670 | ) |
| 671 | _warn(warning, 'keys', keySetName) |
| 672 | else: |
| 673 | for event in keyBindings: |
| 674 | binding = self.GetKeyBinding(keySetName, event) |
| 675 | if binding: |
| 676 | keyBindings[event] = binding |
| 677 | else: #we are going to return a default, print warning |
| 678 | warning = ( |
| 679 | '\n Warning: config.py - IdleConf.GetCoreKeys -\n' |
| 680 | ' problem retrieving key binding for event %r\n' |
| 681 | ' from key set %r.\n' |
| 682 | ' returning default value: %r' % |
| 683 | (event, keySetName, keyBindings[event]) |
| 684 | ) |
| 685 | _warn(warning, 'keys', keySetName, event) |
Steven M. Gava | 17d0154 | 2001-12-03 00:37:28 +0000 | [diff] [blame] | 686 | return keyBindings |
Kurt B. Kaiser | 6655e4b | 2002-12-31 16:03:23 +0000 | [diff] [blame] | 687 | |
Terry Jan Reedy | deb7bf1 | 2014-10-06 23:26:26 -0400 | [diff] [blame] | 688 | def GetExtraHelpSourceList(self, configSet): |
| 689 | """Return list of extra help sources from a given configSet. |
Kurt B. Kaiser | e66675b | 2003-01-27 02:36:18 +0000 | [diff] [blame] | 690 | |
Kurt B. Kaiser | 8e92bf7 | 2003-01-14 22:03:31 +0000 | [diff] [blame] | 691 | Valid configSets are 'user' or 'default'. Return a list of tuples of |
| 692 | the form (menu_item , path_to_help_file , option), or return the empty |
| 693 | list. 'option' is the sequence number of the help resource. 'option' |
| 694 | values determine the position of the menu items on the Help menu, |
| 695 | therefore the returned list must be sorted by 'option'. |
| 696 | |
Kurt B. Kaiser | 6655e4b | 2002-12-31 16:03:23 +0000 | [diff] [blame] | 697 | """ |
Terry Jan Reedy | deb7bf1 | 2014-10-06 23:26:26 -0400 | [diff] [blame] | 698 | helpSources = [] |
| 699 | if configSet == 'user': |
| 700 | cfgParser = self.userCfg['main'] |
| 701 | elif configSet == 'default': |
| 702 | cfgParser = self.defaultCfg['main'] |
Steven M. Gava | 085eb1b | 2002-02-05 04:52:32 +0000 | [diff] [blame] | 703 | else: |
Kurt B. Kaiser | ad66742 | 2007-08-23 01:06:15 +0000 | [diff] [blame] | 704 | raise InvalidConfigSet('Invalid configSet specified') |
Steven M. Gava | 085eb1b | 2002-02-05 04:52:32 +0000 | [diff] [blame] | 705 | options=cfgParser.GetOptionList('HelpFiles') |
| 706 | for option in options: |
Terry Jan Reedy | deb7bf1 | 2014-10-06 23:26:26 -0400 | [diff] [blame] | 707 | value=cfgParser.Get('HelpFiles', option, default=';') |
| 708 | if value.find(';') == -1: #malformed config entry with no ';' |
| 709 | menuItem = '' #make these empty |
| 710 | helpPath = '' #so value won't be added to list |
Steven M. Gava | 085eb1b | 2002-02-05 04:52:32 +0000 | [diff] [blame] | 711 | else: #config entry contains ';' as expected |
Neal Norwitz | 9d72bb4 | 2007-04-17 08:48:32 +0000 | [diff] [blame] | 712 | value=value.split(';') |
Steven M. Gava | 085eb1b | 2002-02-05 04:52:32 +0000 | [diff] [blame] | 713 | menuItem=value[0].strip() |
| 714 | helpPath=value[1].strip() |
| 715 | if menuItem and helpPath: #neither are empty strings |
| 716 | helpSources.append( (menuItem,helpPath,option) ) |
Kurt B. Kaiser | 4718bf8 | 2008-02-12 21:34:12 +0000 | [diff] [blame] | 717 | helpSources.sort(key=lambda x: x[2]) |
Steven M. Gava | 085eb1b | 2002-02-05 04:52:32 +0000 | [diff] [blame] | 718 | return helpSources |
| 719 | |
| 720 | def GetAllExtraHelpSourcesList(self): |
Terry Jan Reedy | deb7bf1 | 2014-10-06 23:26:26 -0400 | [diff] [blame] | 721 | """Return a list of the details of all additional help sources. |
| 722 | |
| 723 | Tuples in the list are those of GetExtraHelpSourceList. |
Steven M. Gava | 085eb1b | 2002-02-05 04:52:32 +0000 | [diff] [blame] | 724 | """ |
Terry Jan Reedy | deb7bf1 | 2014-10-06 23:26:26 -0400 | [diff] [blame] | 725 | allHelpSources = (self.GetExtraHelpSourceList('default') + |
Steven M. Gava | 085eb1b | 2002-02-05 04:52:32 +0000 | [diff] [blame] | 726 | self.GetExtraHelpSourceList('user') ) |
Kurt B. Kaiser | 6655e4b | 2002-12-31 16:03:23 +0000 | [diff] [blame] | 727 | return allHelpSources |
| 728 | |
Terry Jan Reedy | d87d168 | 2015-08-01 18:57:33 -0400 | [diff] [blame] | 729 | def GetFont(self, root, configType, section): |
| 730 | """Retrieve a font from configuration (font, font-size, font-bold) |
| 731 | Intercept the special value 'TkFixedFont' and substitute |
| 732 | the actual font, factoring in some tweaks if needed for |
| 733 | appearance sakes. |
| 734 | |
| 735 | The 'root' parameter can normally be any valid Tkinter widget. |
| 736 | |
| 737 | Return a tuple (family, size, weight) suitable for passing |
| 738 | to tkinter.Font |
| 739 | """ |
| 740 | family = self.GetOption(configType, section, 'font', default='courier') |
| 741 | size = self.GetOption(configType, section, 'font-size', type='int', |
| 742 | default='10') |
| 743 | bold = self.GetOption(configType, section, 'font-bold', default=0, |
| 744 | type='bool') |
| 745 | if (family == 'TkFixedFont'): |
Terry Jan Reedy | 1080d13 | 2016-06-09 21:09:15 -0400 | [diff] [blame] | 746 | f = Font(name='TkFixedFont', exists=True, root=root) |
| 747 | actualFont = Font.actual(f) |
| 748 | family = actualFont['family'] |
| 749 | size = actualFont['size'] |
| 750 | if size <= 0: |
| 751 | size = 10 # if font in pixels, ignore actual size |
| 752 | bold = actualFont['weight'] == 'bold' |
Terry Jan Reedy | d87d168 | 2015-08-01 18:57:33 -0400 | [diff] [blame] | 753 | return (family, size, 'bold' if bold else 'normal') |
| 754 | |
Steven M. Gava | c11ccf3 | 2001-09-24 09:43:17 +0000 | [diff] [blame] | 755 | def LoadCfgFiles(self): |
Terry Jan Reedy | deb7bf1 | 2014-10-06 23:26:26 -0400 | [diff] [blame] | 756 | "Load all configuration files." |
Kurt B. Kaiser | e071277 | 2007-08-23 05:25:55 +0000 | [diff] [blame] | 757 | for key in self.defaultCfg: |
Kurt B. Kaiser | 6655e4b | 2002-12-31 16:03:23 +0000 | [diff] [blame] | 758 | self.defaultCfg[key].Load() |
| 759 | self.userCfg[key].Load() #same keys |
Steven M. Gava | c11ccf3 | 2001-09-24 09:43:17 +0000 | [diff] [blame] | 760 | |
| 761 | def SaveUserCfgFiles(self): |
Terry Jan Reedy | deb7bf1 | 2014-10-06 23:26:26 -0400 | [diff] [blame] | 762 | "Write all loaded user configuration files to disk." |
Kurt B. Kaiser | e071277 | 2007-08-23 05:25:55 +0000 | [diff] [blame] | 763 | for key in self.userCfg: |
Kurt B. Kaiser | 6655e4b | 2002-12-31 16:03:23 +0000 | [diff] [blame] | 764 | self.userCfg[key].Save() |
Steven M. Gava | c11ccf3 | 2001-09-24 09:43:17 +0000 | [diff] [blame] | 765 | |
Steven M. Gava | c11ccf3 | 2001-09-24 09:43:17 +0000 | [diff] [blame] | 766 | |
Terry Jan Reedy | deb7bf1 | 2014-10-06 23:26:26 -0400 | [diff] [blame] | 767 | idleConf = IdleConf() |
| 768 | |
Terry Jan Reedy | 9bdb1ed | 2016-07-10 13:46:34 -0400 | [diff] [blame] | 769 | |
| 770 | _warned = set() |
| 771 | def _warn(msg, *key): |
| 772 | key = (msg,) + key |
| 773 | if key not in _warned: |
| 774 | try: |
| 775 | print(msg, file=sys.stderr) |
| 776 | except OSError: |
| 777 | pass |
| 778 | _warned.add(key) |
| 779 | |
| 780 | |
Terry Jan Reedy | deb7bf1 | 2014-10-06 23:26:26 -0400 | [diff] [blame] | 781 | # TODO Revise test output, write expanded unittest |
Terry Jan Reedy | 1080d13 | 2016-06-09 21:09:15 -0400 | [diff] [blame] | 782 | # |
Steven M. Gava | c11ccf3 | 2001-09-24 09:43:17 +0000 | [diff] [blame] | 783 | if __name__ == '__main__': |
Terry Jan Reedy | 2279aeb | 2016-07-05 20:09:53 -0400 | [diff] [blame] | 784 | from zlib import crc32 |
| 785 | line, crc = 0, 0 |
| 786 | |
| 787 | def sprint(obj): |
| 788 | global line, crc |
| 789 | txt = str(obj) |
| 790 | line += 1 |
| 791 | crc = crc32(txt.encode(encoding='utf-8'), crc) |
| 792 | print(txt) |
| 793 | #print('***', line, crc, '***') # uncomment for diagnosis |
| 794 | |
Steven M. Gava | c11ccf3 | 2001-09-24 09:43:17 +0000 | [diff] [blame] | 795 | def dumpCfg(cfg): |
Terry Jan Reedy | 2279aeb | 2016-07-05 20:09:53 -0400 | [diff] [blame] | 796 | print('\n', cfg, '\n') # has variable '0xnnnnnnnn' addresses |
| 797 | for key in sorted(cfg.keys()): |
Terry Jan Reedy | deb7bf1 | 2014-10-06 23:26:26 -0400 | [diff] [blame] | 798 | sections = cfg[key].sections() |
Terry Jan Reedy | 2279aeb | 2016-07-05 20:09:53 -0400 | [diff] [blame] | 799 | sprint(key) |
| 800 | sprint(sections) |
Steven M. Gava | c11ccf3 | 2001-09-24 09:43:17 +0000 | [diff] [blame] | 801 | for section in sections: |
Terry Jan Reedy | deb7bf1 | 2014-10-06 23:26:26 -0400 | [diff] [blame] | 802 | options = cfg[key].options(section) |
Terry Jan Reedy | 2279aeb | 2016-07-05 20:09:53 -0400 | [diff] [blame] | 803 | sprint(section) |
| 804 | sprint(options) |
Steven M. Gava | c11ccf3 | 2001-09-24 09:43:17 +0000 | [diff] [blame] | 805 | for option in options: |
Terry Jan Reedy | 2279aeb | 2016-07-05 20:09:53 -0400 | [diff] [blame] | 806 | sprint(option + ' = ' + cfg[key].Get(section, option)) |
| 807 | |
Steven M. Gava | c11ccf3 | 2001-09-24 09:43:17 +0000 | [diff] [blame] | 808 | dumpCfg(idleConf.defaultCfg) |
| 809 | dumpCfg(idleConf.userCfg) |
Terry Jan Reedy | 2279aeb | 2016-07-05 20:09:53 -0400 | [diff] [blame] | 810 | print('\nlines = ', line, ', crc = ', crc, sep='') |