cola/resources.py

   1 """Provides the prefix() function for finding cola resources"""
   2 import os
   3 import webbrowser
   4
   5 _modpath = os.path.abspath(__file__)
   6 if 'share' in __file__ and 'lib' in __file__:
   7     # this is the release tree
   8     # __file__ = '$prefix/share/git-cola/lib/cola/__file__.py'
   9     _lib_dir = os.path.dirname(os.path.dirname(_modpath))
  10     _prefix = os.path.dirname(os.path.dirname(os.path.dirname(_lib_dir)))
  11 else:
  12     # this is the source tree
  13     # __file__ = '$prefix/cola/__file__.py'
  14     _prefix = os.path.dirname(os.path.dirname(_modpath))
  15
  16
  17 def prefix(*args):
  18     """Return a path relative to cola's installation prefix"""
  19     return os.path.join(_prefix, *args)
  20
  21
  22 def doc(*args):
  23     """Return a path relative to cola's /usr/share/doc/ directory"""
  24     return os.path.join(_prefix, 'share', 'doc', 'git-cola', *args)
  25
  26
  27 def html_docs():
  28     """Return the path to the cola html documentation."""
  29     # index.html only exists after the install-docs target is run,
  30     # so fallback to git-cola.txt.
  31     htmldocs = doc('html', 'index.html')
  32     if os.path.exists(htmldocs):
  33         return htmldocs
  34     return doc('git-cola.txt')
  35
  36
  37 def show_html_docs():
  38     url = html_docs()
  39     webbrowser.open_new_tab(url)
  40
  41 def share(*args):
  42     """Return a path relative to cola's /usr/share/ directory"""
  43     return prefix('share', 'git-cola', *args)
  44
  45
  46 def icon(basename):
  47     """Return the full path to an icon file given a basename."""
  48     return 'icons:'+basename
  49
  50
  51 def icon_dir():
  52     """Return the path to the style dir within the cola install tree."""
  53     return share('icons')