cola/icons.py

   1 """The only file where icon filenames are mentioned"""
   2
   3 from __future__ import absolute_import, division, unicode_literals
   4 import mimetypes
   5 import os
   6
   7 from qtpy import QtGui
   8 from qtpy import QtWidgets
   9
  10 from . import qtcompat
  11 from . import resources
  12 from .compat import ustr
  13 from .decorators import memoize
  14
  15
  16 KNOWN_FILE_MIME_TYPES = [
  17     ('text', 'file-code.svg'),
  18     ('image', 'file-media.svg'),
  19     ('octet', 'file-binary.svg'),
  20 ]
  21
  22 KNOWN_FILE_EXTENSIONS = {
  23     '.bash': 'file-code.svg',
  24     '.c': 'file-code.svg',
  25     '.cpp': 'file-code.svg',
  26     '.css': 'file-code.svg',
  27     '.cxx': 'file-code.svg',
  28     '.h': 'file-code.svg',
  29     '.hpp': 'file-code.svg',
  30     '.hs': 'file-code.svg',
  31     '.html': 'file-code.svg',
  32     '.java': 'file-code.svg',
  33     '.js': 'file-code.svg',
  34     '.ksh': 'file-code.svg',
  35     '.lisp': 'file-code.svg',
  36     '.perl': 'file-code.svg',
  37     '.pl': 'file-code.svg',
  38     '.py': 'file-code.svg',
  39     '.rb': 'file-code.svg',
  40     '.rs': 'file-code.svg',
  41     '.sh': 'file-code.svg',
  42     '.zsh': 'file-code.svg',
  43 }
  44
  45
  46 def install(icon_themes):
  47     for theme in icon_themes:
  48         icon_dir = resources.icon_dir(theme)
  49         qtcompat.add_search_path('icons', icon_dir)
  50
  51
  52 def name_from_basename(basename):
  53     """Prefix the basename with "icons:" so that git-cola's icons are found
  54
  55     "icons" is registered with Qt's resource system during install().
  56
  57     """
  58     return 'icons:' + basename
  59
  60
  61 @memoize
  62 def from_name(name):
  63     """Return a QIcon from an absolute filename or "icons:basename.svg" name"""
  64     return QtGui.QIcon(name)
  65
  66
  67 def icon(basename):
  68     """Given a basename returns a QIcon from the corresponding cola icon"""
  69     return from_name(name_from_basename(basename))
  70
  71
  72 @memoize
  73 def from_theme(name, fallback=None):
  74     """Grab an icon from the current theme with a fallback
  75
  76     Support older versions of Qt checking for fromTheme's availability.
  77
  78     """
  79     if hasattr(QtGui.QIcon, 'fromTheme'):
  80         base, _ = os.path.splitext(name)
  81         if fallback:
  82             qicon = QtGui.QIcon.fromTheme(base, icon(fallback))
  83         else:
  84             qicon = QtGui.QIcon.fromTheme(base)
  85         if not qicon.isNull():
  86             return qicon
  87     return icon(fallback or name)
  88
  89
  90 def basename_from_filename(filename):
  91     """Returns an icon name based on the filename"""
  92     mimetype = mimetypes.guess_type(filename)[0]
  93     if mimetype is not None:
  94         mimetype = mimetype.lower()
  95         for filetype, icon_name in KNOWN_FILE_MIME_TYPES:
  96             if filetype in mimetype:
  97                 return icon_name
  98     extension = os.path.splitext(filename)[1]
  99     return KNOWN_FILE_EXTENSIONS.get(extension.lower(), 'file-text.svg')
 100
 101
 102 def from_filename(filename):
 103     basename = basename_from_filename(filename)
 104     return from_name(name_from_basename(basename))
 105
 106
 107 def mkicon(value, default=None):
 108     if value is None and default is not None:
 109         value = default()
 110     elif value and isinstance(value, (str, ustr)):
 111         value = QtGui.QIcon(value)
 112     return value
 113
 114
 115 def from_style(key):
 116     """Maintain a cache of standard icons and return cache entries."""
 117     style = QtWidgets.QApplication.instance().style()
 118     return style.standardIcon(key)
 119
 120
 121 def status(filename, deleted, is_staged, untracked):
 122     if deleted:
 123         icon_name = 'circle-slash-red.svg'
 124     elif is_staged:
 125         icon_name = 'staged.svg'
 126     elif untracked:
 127         icon_name = 'question-plain.svg'
 128     else:
 129         icon_name = basename_from_filename(filename)
 130     return icon_name
 131
 132
 133 # Icons creators and SVG file references
 134
 135 def add():
 136     return from_theme('list-add', fallback='plus.svg')
 137
 138
 139 def branch():
 140     return icon('git-branch.svg')
 141
 142
 143 def check_name():
 144     return name_from_basename('check.svg')
 145
 146
 147 def close():
 148     return icon('x.svg')
 149
 150
 151 def cola():
 152     return icon('git-cola.svg')
 153
 154
 155 def commit():
 156     return icon('document-save-symbolic.svg')
 157
 158
 159 def compare():
 160     return icon('git-compare.svg')
 161
 162
 163 def configure():
 164     return from_theme('configure', fallback='gear.svg')
 165
 166
 167 def copy():
 168     return from_theme('edit-copy.svg')
 169
 170
 171 def default_app():
 172     return icon('telescope.svg')
 173
 174
 175 def dot_name():
 176     return name_from_basename('primitive-dot.svg')
 177
 178
 179 def download():
 180     return icon('file-download.svg')
 181
 182
 183 def discard():
 184     return icon('trashcan.svg')
 185
 186
 187 # folder vs directory: directory is opaque, folder is just an outline
 188 # directory is used for the File Browser, where more contrast with the file
 189 # icons are needed.
 190
 191 def folder():
 192     return icon('folder.svg')
 193
 194
 195 def directory():
 196     return icon('file-directory.svg')
 197
 198
 199 def diff():
 200     return icon('diff.svg')
 201
 202
 203 def edit():
 204     return icon('pencil.svg')
 205
 206
 207 def ellipsis():
 208     return icon('ellipsis.svg')
 209
 210
 211 def external():
 212     return icon('link-external.svg')
 213
 214
 215 def file_code():
 216     return icon('file-code.svg')
 217
 218
 219 def file_text():
 220     return icon('file-text.svg')
 221
 222
 223 def file_zip():
 224     return icon('file-zip.svg')
 225
 226
 227 def fold():
 228     return icon('fold.svg')
 229
 230
 231 def merge():
 232     return icon('git-merge.svg')
 233
 234
 235 def modified_name():
 236     return name_from_basename('modified.svg')
 237
 238
 239 def new():
 240     return icon('folder-new.svg')
 241
 242
 243 def ok():
 244     return icon('check.svg')
 245
 246
 247 def open_directory():
 248     return icon('folder.svg')
 249
 250
 251 def partial_name():
 252     return name_from_basename('partial.svg')
 253
 254
 255 def pull():
 256     return icon('repo-pull.svg')
 257
 258
 259 def push():
 260     return icon('repo-push.svg')
 261
 262
 263 def question():
 264     return icon('question.svg')
 265
 266
 267 def remove():
 268     return from_theme('list-remove', fallback='circle-slash.svg')
 269
 270
 271 def repo():
 272     return icon('repo.svg')
 273
 274
 275 def save():
 276     return icon('desktop-download.svg')
 277
 278
 279 def search():
 280     return icon('search.svg')
 281
 282
 283 def select_all():
 284     return from_theme('edit-select-all.svg')
 285
 286
 287 def staged():
 288     return icon('staged.svg')
 289
 290
 291 def staged_name():
 292     return name_from_basename('staged.svg')
 293
 294
 295 def star():
 296     return icon('star.svg')
 297
 298
 299 def sync():
 300     return icon('sync.svg')
 301
 302
 303 def tag():
 304     return icon('tag.svg')
 305
 306
 307 def undo():
 308     return from_theme('edit-undo', fallback='edit-undo.svg')
 309
 310
 311 def unfold():
 312     return icon('unfold.svg')
 313
 314
 315 def visualize():
 316     return icon('eye.svg')
 317
 318
 319 def upstream_name():
 320     return name_from_basename('upstream.svg')
 321
 322
 323 def zoom_fit_best():
 324     return icon('zoom-fit-best.svg')
 325
 326
 327 def zoom_in():
 328     return icon('zoom-in.svg')
 329
 330
 331 def zoom_out():
 332     return icon('zoom-out.svg')