# -*- coding: utf-8 -*-
#Canto-curses - ncurses RSS reader
-# Copyright (C) 2010 Jack Miller <jack@codezen.org>
+# Copyright (C) 2014 Jack Miller <jack@codezen.org>
#
# This program is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License version 2 as
# published by the Free Software Foundation.
-from theme import FakePad, WrapPad, theme_print
-from story import Story
+from canto_next.hooks import call_hook, on_hook, unhook_all
+from canto_next.plugins import Plugin, PluginHandler
+from canto_next.rwlock import read_lock
+from .locks import sync_lock, config_lock
+from .parser import try_parse, try_eval, prep_for_display
+from .theme import FakePad, WrapPad, theme_print, theme_reset, theme_border
+from .config import config, DEFAULT_TAG_FSTRING
+from .story import Story
+
+import traceback
import logging
import curses
log = logging.getLogger("TAG")
-# The Tag class manages stories. Externally, it looks
-# like a Tag takes IDs from the backend and renders an ncurses pad. No class
-# other than Tag actually touches Story objects directly.
+# TagCore provides the core tag functionality of keeping track of a list of IDs.
+
+# The Tag class manages stories. Externally, it looks like a Tag takes IDs from
+# the backend and renders an ncurses pad. No class other than Tag actually
+# touches Story objects directly.
+
+class TagPlugin(Plugin):
+ pass
-class Tag(list):
- def __init__(self, tag, callbacks):
+alltags = []
+
+class Tag(PluginHandler, list):
+ def __init__(self, tagcore, callbacks):
list.__init__(self)
+ PluginHandler.__init__(self)
+
+ self.tagcore = tagcore
+ self.tag = tagcore.tag
+ self.is_tag = True
+ self.updates_pending = 0
+
+ self.pad = None
+ self.footpad = None
# Note that Tag() is only given the top-level CantoCursesGui
# callbacks as it shouldn't be doing input / refreshing
# itself.
- self.callbacks = callbacks
- self.tag = tag
+ self.callbacks = callbacks.copy()
+
+ # Modify our own callbacks so that *_tag_opt assumes
+ # the current tag.
+
+ self.callbacks["get_tag_opt"] =\
+ lambda x : callbacks["get_tag_opt"](self.tag, x)
+ self.callbacks["set_tag_opt"] =\
+ lambda x, y : callbacks["set_tag_opt"](self.tag, x, y)
+ self.callbacks["get_tag_name"] = lambda : self.tag
+
+ # This could be implemented as a generic, top-level hook but then N
+ # tags would have access to story objects they shouldn't have and
+ # would have to check every items membership in self, which would be
+ # pointless and time-consuming.
+
+ self.callbacks["item_state_change"] =\
+ self.on_item_state_change
+
+ # Are there changes pending?
+ self.changed = True
+
+ self.selected = False
+ self.marked = False
+
+ # Information from last refresh
+ self.footlines = 0
+ self.extra_lines = 0
+ self.width = 0
+
+ self.collapsed = False
+ self.border = False
+ self.enumerated = False
+ self.abs_enumerated = False
+
+ # Formats for plugins to override
+ self.pre_format = ""
+ self.post_format = ""
+
+ # Global indices (for enumeration)
+ self.item_offset = 0
+ self.visible_tag_offset = 0
+ self.tag_offset = 0
+ self.sel_offset = 0
+
+ on_hook("curses_opt_change", self.on_opt_change, self)
+ on_hook("curses_tag_opt_change", self.on_tag_opt_change, self)
+ on_hook("curses_attributes", self.on_attributes, self)
+ on_hook("curses_items_added", self.on_items_added, self)
# Upon creation, this Tag adds itself to the
# list of all tags.
- callbacks["get_var"]("alltags").append(self)
+ alltags.append(self)
+
+ self.sync(True)
+
+ self.plugin_class = TagPlugin
+ self.update_plugin_lookups()
+
+ def die(self):
+ log.debug("tag %s die()" % self.tag)
+ # Reset so items get die() called and everything
+ # else is notified about items disappearing.
+
+ for s in self:
+ s.die()
+ del self[:]
+
+ alltags.remove(self)
+
+ unhook_all(self)
+
+ def on_item_state_change(self, item):
+ self.need_redraw()
+
+ def on_opt_change(self, opts):
+ if "taglist" in opts and\
+ ("tags_enumerated" in opts["taglist"] or\
+ "tags_enumerated_absolute" in opts["taglist"] or\
+ "border" in opts["taglist"]):
+ self.need_redraw()
+
+ if "tagobj" in opts:
+ self.need_redraw()
+
+ def on_tag_opt_change(self, opts):
+ if self.tag in list(opts.keys()):
+ tc = opts[self.tag]
+ if "collapsed" in tc:
+ self.need_refresh()
+ else:
+ self.need_redraw()
+
+ # Technically, we might want to hold sync_lock so that self[:] doesn't
+ # change, but if we're syncing, the setting of needs_redraw isn't important
+ # anymore, and if we're not, there's no issue.
+
+ def on_attributes(self, attributes):
+ for s in self:
+ if s.id in attributes:
+ self.need_redraw()
+ break
+
+ def on_items_added(self, tagcore, added):
+ cur_ids = self.get_ids()
+ if tagcore == self.tagcore:
+ for story_id in added:
+ if story_id not in cur_ids:
+ self.updates_pending += 1
+ self.need_redraw()
# We override eq so that empty tags don't evaluate
# as equal and screw up things like enumeration.
def __eq__(self, other):
- if self.tag != other.tag:
+ if other and (not other.is_tag or self.tag != other.tag):
return False
return list.__eq__(self, other)
- # Create Story from ID before appending to list.
-
- def append(self, id):
- s = Story(id, self.callbacks)
- list.append(self, s)
-
- # Remove Story based on ID
-
- def remove(self, id):
- log.debug("removing: %s" % (id,))
- for item in self:
- if item.id == id:
- list.remove(self, item)
+ def __str__(self):
+ return "%s" % self.tag[self.tag.index(':') + 1:]
def get_id(self, id):
for item in self:
if item.id == id:
return item
- return None
def get_ids(self):
return [ s.id for s in self ]
- def refresh(self, mwidth, idx_offset):
+ # Inform the tag of global index of it's first item.
+ def set_item_offset(self, offset):
+ if self.item_offset != offset:
+ self.item_offset = offset
+ for i, item in enumerate(self):
+ item.set_offset(offset + i)
+
+ # Note that this cannot be short-cut (i.e.
+ # copout if sel_offset is already equal)
+ # because it's possible that it's the same
+ # without the items having ever been updated.
+
+ # Alternatively, we could reset them in
+ # on_tag_opt_change, but since the sel
+ # offset does not cause a redraw, there's
+ # no point.
+
+ def set_sel_offset(self, offset):
+ self.sel_offset = offset
+
+ if not self.callbacks["get_tag_opt"]("collapsed"):
+ for i, item in enumerate(self):
+ item.set_sel_offset(offset + i)
+
+ def set_visible_tag_offset(self, offset):
+ if self.visible_tag_offset != offset:
+ self.visible_tag_offset = offset
+ self.need_redraw()
+
+ def set_tag_offset(self, offset):
+ if self.tag_offset != offset:
+ self.tag_offset = offset
+ self.need_redraw()
+
+ def select(self):
+ if not self.selected:
+ self.selected = True
+ self.need_redraw()
- lines = self.render_header(mwidth, FakePad(mwidth))
+ def unselect(self):
+ if self.selected:
+ self.selected = False
+ self.need_redraw()
- self.header_pad = curses.newpad(lines, mwidth)
+ def need_refresh(self):
+ self.changed = True
+ self.callbacks["set_var"]("needs_refresh", True)
- for i, item in enumerate(self):
- lines += item.refresh(mwidth, idx_offset + i)
+ def need_redraw(self):
+ self.changed = True
+ self.callbacks["set_var"]("needs_redraw", True)
- # Create a new pad with enough lines to
- # include all story objects.
- self.pad = curses.newpad(lines, mwidth)
+ def lines(self, width):
+ if width == self.width and not self.changed:
+ return self.lns
- return self.render(mwidth, WrapPad(self.pad))
+ tag_conf = self.callbacks["get_opt"]("tagobj")
+ taglist_conf = self.callbacks["get_opt"]("taglist")
- def render_header(self, mwidth, pad):
- enumerated = self.callbacks["get_opt"]("taglist.tags_enumerated")
- header = self.tag + u"\n"
- if enumerated:
- curtags = self.callbacks["get_var"]("curtags")
- header = ("[%d] " % curtags.index(self)) + header
+ # Values to pass on to render
+ self.collapsed = self.callbacks["get_tag_opt"]("collapsed")
+ self.border = taglist_conf["border"]
+ self.enumerated = taglist_conf["tags_enumerated"]
+ self.abs_enumerated = taglist_conf["tags_enumerated_absolute"]
+ # Make sure to strip out the category from category:name
+ tag = self.tag.split(':', 1)[1]
+
+ unread = len([s for s in self\
+ if "canto-state" not in s.content or\
+ "read" not in s.content["canto-state"]])
+
+ extra_tags = self.callbacks["get_tag_conf"](self.tag)['extra_tags']
+
+ # These are escapes that are handled in the theme_print
+ # lower in the function and should remain present after
+ # evaluation.
+
+ passthru = {}
+ for c in "RrDdUuBbSs012345678[":
+ passthru[c] = "%" + c
+
+ for attr in [ "selected", "unselected", "selected_end", "unselected_end" ]:
+ passthru[attr] = tag_conf[attr]
+
+ passthru['pre'] = self.pre_format
+ passthru['post'] = self.post_format
+
+ parsed = try_parse(tag_conf["format"], DEFAULT_TAG_FSTRING)
+ parsed_pre = try_parse(self.pre_format, "")
+ parsed_post = try_parse(self.post_format, "")
+
+ values = { 'c' : self.collapsed,
+ 't' : tag,
+ 'sel' : self.selected,
+ 'n' : unread,
+ "extra_tags" : extra_tags,
+ 'tag' : self,
+ 'pending' : self.updates_pending,
+ 'prep' : prep_for_display}
+
+ # Prep all text values for display.
+
+ for value in list(values.keys()):
+ if type(values[value]) in [str, str]:
+ values[value] = prep_for_display(values[value])
+
+ values.update(passthru)
+
+ values["pre"] = try_eval(parsed_pre, values, "")
+ values["post"] = try_eval(parsed_post, values, "")
+ self.evald_string = try_eval(parsed, values, DEFAULT_TAG_FSTRING)
+
+ self.pad = None
+ self.footpad = None
+ self.width = width
+ self.changed = False
+
+ self.lns = self.render_header(width, FakePad(width))
+ self.footlines = self.render_footer(width, FakePad(width))
+
+ return self.lns
+
+ def pads(self, width):
+ if self.pad and (self.footpad or not self.footlines) and not self.changed:
+ return self.lns
+
+ self.pad = curses.newpad(self.lines(width), width)
+ self.render_header(width, WrapPad(self.pad))
+
+ if self.footlines:
+ self.footpad = curses.newpad(self.footlines, width)
+ self.render_footer(width, WrapPad(self.footpad))
+ return self.lns
+
+ def render_header(self, width, pad):
+ s = self.evald_string
lines = 0
- while header:
- header = theme_print(pad, header, mwidth, u"", u"")
- lines += 1
+ try:
+ while s:
+ s = theme_print(pad, s, width, "", "")
+
+ if lines == 0:
+ header = ""
+ if self.enumerated:
+ header += "%1[" + str(self.visible_tag_offset) + "]%0"
+ if self.abs_enumerated:
+ header += "%1[" + str(self.tag_offset) + "]%0"
+ if header:
+ pad.move(0, 0)
+ theme_print(pad, header, width, "", "", False, False)
+ try:
+ pad.move(1, 0)
+ except:
+ pass
+ lines += 1
+
+ if not self.collapsed and self.border:
+ theme_print(pad, theme_border("ts") * (width - 2), width,\
+ "%B"+ theme_border("tl"), theme_border("tr") + "%b")
+ lines += 1
+ except Exception as e:
+ tb = traceback.format_exc()
+ log.debug("Tag exception:")
+ log.debug("\n" + "".join(tb))
+
+ theme_reset()
return lines
- def render(self, mwidth, pad):
- # Update header_pad (used to float tag header)
- self.render_header(mwidth, WrapPad(self.header_pad))
+ def render_footer(self, width, pad):
+ if not self.collapsed and self.border:
+ theme_print(pad, theme_border("bs") * (width - 2), width,\
+ "%B" + theme_border("bl"), theme_border("br") + "%b")
+ theme_reset()
+ return 1
+ return 0
- # Render to the taglist pad as well.
- spent_lines = self.render_header(mwidth, pad)
- mp = [spent_lines]
+ # Synchronize this Tag with its TagCore
- for item in self:
- cur_lines = item.pad.getmaxyx()[0]
- mp.append(cur_lines)
+ def sync(self, force=False):
+ if force or self.tagcore.changes:
+ current_stories = []
+ added_stories = []
+
+ sel = self.callbacks["get_var"]("selected")
+
+ self.tagcore.lock.acquire_read()
+
+ self.tagcore.ack_changes()
+
+ for story in self:
+ if story.id in self.tagcore:
+ current_stories.append((self.tagcore.index(story.id), story))
+ elif story == sel:
+
+ # If we preserve the selection in an "undead" state, then
+ # we keep set tagcore changed so that the next sync operation
+ # will re-evaluate it.
+
+ self.tagcore.changed()
+
+ if current_stories:
+ place = max([ x[0] for x in current_stories ]) + .5
+ else:
+ place = -1
+ current_stories.append((place, story))
+
+ for place, id in enumerate(self.tagcore):
+ if id not in [ x[1].id for x in current_stories ]:
+ s = Story(self, id, self.callbacks)
+ current_stories.append((place, s))
+ added_stories.append(s)
+
+ self.tagcore.lock.release_read()
+
+ call_hook("curses_stories_added", [ self, added_stories ])
+
+ conf = config.get_conf()
+ if conf["update"]["style"] == "maintain" or self.tagcore.was_reset:
+ self.tagcore.was_reset = False
+ current_stories.sort()
+
+ current_stories = [ x[1] for x in current_stories ]
+
+ deleted = []
+
+ for story in self:
+ if not story in current_stories:
+ deleted.append(story)
+ story.die()
+
+ # Properly dispose of the remaining stories
+
+ call_hook("curses_stories_removed", [ self, deleted ])
+
+ del self[:]
+ self.extend(current_stories)
+
+ # Trigger a refresh so that classes above (i.e. TagList) will remap
+ # items
- # Copy the item pad into the Tag's pad.
- item.pad.overwrite(self.pad, 0, 0, spent_lines, 0,\
- spent_lines + cur_lines - 1 , mwidth - 1)
+ self.need_refresh()
- spent_lines += cur_lines
+ # Pass the sync onto story objects
+ for s in self:
+ s.sync()
- # Return a list of integers, the heights of the header,
- # and all of the stories. The sum must == the height
- # of the tag's pad.
- return mp
+ self.updates_pending = 0
projects / canto-curses.git / blobdiff