def __init__(self):
"""Creates the position manager object
"""
object.__init__(self)
# Attributes
self._init = False
self._book = None
self._records = dict()
# Non persisted navigation cache
self._poscache = ebmlib.HistoryCache(100) # save last 100 positions
class DocPositionMgr(object):
"""Object for managing the saving and setting of a collection of
documents positions between sessions. Through the use of an in memory
dictionary during run time and on disk dictionary to use when starting
and stopping the editor.
@note: saves config to ~/.Editra/cache/
"""
_poscache = ebmlib.HistoryCache(100)
def __init__(self):
"""Creates the position manager object"""
super(DocPositionMgr, self).__init__()
# Attributes
self._init = False
self._book = None
self._records = dict()
def InitPositionCache(self, book_path):
"""Initialize and load the on disk document position cache.
@param book_path: path to on disk cache
"""
self._init = True
self._book = book_path
if Profile_Get('SAVE_POS'):
self.LoadBook(book_path)
@classmethod
def AddNaviPosition(cls, fname, pos):
"""Add a new position to the navigation cache
@param fname: file name
@param pos: position
"""
# Don't put two identical positions in the cache next to each other
pre = cls._poscache.PeekPrevious()
next = cls._poscache.PeekNext()
if (fname, pos) in (pre, next):
return
cls._poscache.PutItem((fname, pos))
def AddRecord(self, vals):
"""Adds a record to the dictionary from a list of the
filename vals[0] and the position value vals[1].
@param vals: (file path, cursor position)
"""
if len(vals) == 2:
self._records[vals[0]] = vals[1]
return True
else:
return False
@classmethod
def CanNavigateNext(cls):
"""Are there more cached navigation positions?
@param cls: Class
@return: bool
"""
return cls._poscache.HasNext()
@classmethod
def CanNavigatePrev(cls):
"""Are there previous cached navigation positions?
@param cls: Class
@return: bool
"""
return cls._poscache.HasPrevious()
@classmethod
def FlushNaviCache(cls):
"""Clear the navigation cache"""
cls._poscache.Clear()
@classmethod
def GetNaviCacheSize(cls):
return cls._poscache.GetSize()
def GetBook(self):
"""Returns the current book used by this object
@return: path to book used by this manager
"""
return self._book
@classmethod
def GetNextNaviPos(cls, fname=None):
"""Get the next stored navigation position
The optional fname parameter will get the next found position for
the given file.
@param cls: Class
@param fname: filename (note currently not supported)
@return: int or None
@note: fname is currently not used
"""
item = cls._poscache.GetNextItem()
return item
@classmethod
def GetPreviousNaviPos(cls, fname=None):
"""Get the last stored navigation position
The optional fname parameter will get the last found position for
the given file.
@param cls: Class
@param fname: filename (note currently not supported)
@return: int or None
@note: fname is currently not used
"""
item = cls._poscache.GetPreviousItem()
return item
def GetPos(self, name):
"""Get the position record for a given filename
returns 0 if record is not found.
@param name: file name
@return: position value for the given filename
"""
return self._records.get(name, 0)
def IsInitialized(self):
"""Has the cache been initialized
@return: bool
"""
return self._init
def LoadBook(self, book):
"""Loads a set of records from an on disk dictionary
the entries are formated as key=value with one entry
per line in the file.
@param book: path to saved file
@return: whether book was loaded or not
"""
# If file does not exist create it and return
if not os.path.exists(book):
try:
tfile = util.GetFileWriter(book)
tfile.close()
except (IOError, OSError):
util.Log("[docpositionmgr][err] failed to load book: %s" %
book)
return False
except AttributeError:
util.Log("[docpositionmgr][err] Failed to create: %s" % book)
return False
reader = util.GetFileReader(book, sys.getfilesystemencoding())
if reader != -1:
lines = list()
try:
lines = reader.readlines()
except:
reader.close()
return False
else:
reader.close()
for line in lines:
line = line.strip()
vals = line.rsplit(u'=', 1)
if len(vals) != 2 or not os.path.exists(vals[0]):
continue
try:
vals[1] = int(vals[1])
except (TypeError, ValueError), msg:
util.Log("[docpositionmgr][err] %s" % str(msg))
continue
else:
self._records[vals[0]] = vals[1]
util.Log("[docpositionmgr][info] successfully loaded book")
return True
def setUp(self):
self.cache = ebmlib.HistoryCache()