Merge pull request #1256 from pazz/namedqueries

New buffer type for notmuch's named query strings

9 files changed, 112 insertions, 21 deletions

diff --git a/docs/source/api/commands.rst b/docs/source/api/commands.rst
index cae10a03..13520b13 100644
--- a/docs/source/api/commands.rst
+++ b/docs/source/api/commands.rst
@@ -73,6 +73,12 @@ Taglist
 .. automodule:: alot.commands.taglist
   :members:
 
+Namedqueries
+------------
+
+.. automodule:: alot.commands.namedqueries
+  :members:
+
 Thread
 --------
 
diff --git a/docs/source/api/interface.rst b/docs/source/api/interface.rst
index 39b9cd3c..7babae93 100644
--- a/docs/source/api/interface.rst
+++ b/docs/source/api/interface.rst
@@ -53,18 +53,19 @@ Different modes are defined by subclasses of the following base class.
 
 Available modes are:
 
-========== ========================================
-   Mode     Buffer Subclass
-========== ========================================
-search     :class:`~alot.buffers.SearchBuffer`
-thread     :class:`~alot.buffers.ThreadBuffer`
-bufferlist :class:`~alot.buffers.BufferlistBuffer`
-taglist    :class:`~alot.buffers.TagListBuffer`
-envelope   :class:`~alot.buffers.EnvelopeBuffer`
-========== ========================================
+============ ========================================
+   Mode       Buffer Subclass
+============ ========================================
+search       :class:`~alot.buffers.SearchBuffer`
+thread       :class:`~alot.buffers.ThreadBuffer`
+bufferlist   :class:`~alot.buffers.BufferlistBuffer`
+taglist      :class:`~alot.buffers.TagListBuffer`
+namedqueries :class:`~alot.buffers.NamedQueriesBuffer`
+envelope     :class:`~alot.buffers.EnvelopeBuffer`
+============ ========================================
 
 .. automodule:: alot.buffers
-    :members: BufferlistBuffer, EnvelopeBuffer,SearchBuffer,ThreadBuffer,TagListBuffer
+    :members: BufferlistBuffer, EnvelopeBuffer, NamedQueriesBuffer, SearchBuffer, ThreadBuffer, TagListBuffer
 
 Widgets
 --------
diff --git a/docs/source/configuration/alotrc_table b/docs/source/configuration/alotrc_table
index 5806f7bd..8cc208bd 100644
--- a/docs/source/configuration/alotrc_table
+++ b/docs/source/configuration/alotrc_table
@@ -391,6 +391,19 @@
     :default: True
 
 
+.. _namedqueries-statusbar:
+
+.. describe:: namedqueries_statusbar
+
+     Format of the status-bar in named query list mode.
+     This is a pair of strings to be left and right aligned in the status-bar.
+     These strings may contain variables listed at :ref:`bufferlist_statusbar <bufferlist-statusbar>`
+     that will be substituted accordingly.
+
+    :type: mixed_list
+    :default: [{buffer_no}: namedqueries], {query_count} named queries
+
+
 .. _notify-timeout:
 
 .. describe:: notify_timeout
diff --git a/docs/source/configuration/key_bindings.rst b/docs/source/configuration/key_bindings.rst
index fe8da87f..7f6e2787 100644
--- a/docs/source/configuration/key_bindings.rst
+++ b/docs/source/configuration/key_bindings.rst
@@ -21,11 +21,12 @@ and be able to toggle this tag in search mode, you'd add this to your config
 
 Known modes are:
 
+* bufferlist
 * envelope
+* namedqueries
 * search
-* thread
 * taglist
-* bufferlist
+* thread
 
 Have a look at `the urwid User Input documentation <http://excess.org/urwid/wiki/UserInput>`_ on how key strings are formatted.
 
diff --git a/docs/source/usage/cli_commands.rst b/docs/source/usage/cli_commands.rst
index b1b4b369..fdd9efc5 100644
--- a/docs/source/usage/cli_commands.rst
+++ b/docs/source/usage/cli_commands.rst
@@ -11,5 +11,8 @@ bufferlist
 taglist
     start with only a taglist buffer open
 
+namedqueries
+    start with list of named queries
+
 pyshell
     start the interactive python shell inside alot
diff --git a/docs/source/usage/commands.rst b/docs/source/usage/commands.rst
index 6fa99b58..96d66649 100644
--- a/docs/source/usage/commands.rst
+++ b/docs/source/usage/commands.rst
@@ -13,25 +13,28 @@ See the sections below for which commands are available in which (UI) mode.
 
 :doc:`modes/global`
     globally available commands
-:doc:`modes/search`
-    commands available when showing thread search results
-:doc:`modes/thread`
-    commands available while displaying a thread
-:doc:`modes/envelope`
-    commands during message composition
 :doc:`modes/bufferlist`
     commands while listing active buffers
+:doc:`modes/envelope`
+    commands during message composition
+:doc:`modes/namedqueries`
+    commands while listing all named queries from the notmuch database
+:doc:`modes/search`
+    commands available when showing thread search results
 :doc:`modes/taglist`
     commands while listing all tagstrings present in the notmuch database
+:doc:`modes/thread`
+    commands available while displaying a thread
 
 .. toctree::
    :maxdepth: 2
    :hidden:
 
    modes/global
-   modes/search
-   modes/thread
-   modes/envelope
    modes/bufferlist
+   modes/envelope
+   modes/namedqueries
+   modes/search
    modes/taglist
+   modes/thread
 
diff --git a/docs/source/usage/modes/global.rst b/docs/source/usage/modes/global.rst
index 6e79c67a..1831a6cb 100644
--- a/docs/source/usage/modes/global.rst
+++ b/docs/source/usage/modes/global.rst
@@ -117,6 +117,13 @@ The following commands are available globally
         up, down, [half]page up, [half]page down, first, last
 
 
+.. _cmd.global.namedqueries:
+
+.. describe:: namedqueries
+
+    opens named queries buffer
+
+
 .. _cmd.global.prompt:
 
 .. describe:: prompt
@@ -148,6 +155,18 @@ The following commands are available globally
     Reload all configuration files
 
 
+.. _cmd.global.removequery:
+
+.. describe:: removequery
+
+    removes a "named query" from the database
+
+    argument
+        alias to remove
+
+    optional arguments
+        :---no-flush: postpone a writeout to the index (Defaults to: 'True').
+
 .. _cmd.global.repeat:
 
 .. describe:: repeat
@@ -155,6 +174,20 @@ The following commands are available globally
     Repeats the command executed last time
 
 
+.. _cmd.global.savequery:
+
+.. describe:: savequery
+
+    store query string as a "named query" in the database
+
+    positional arguments
+        0: alias to use for query string
+        1: query string to store
+
+
+    optional arguments
+        :---no-flush: postpone a writeout to the index (Defaults to: 'True').
+
 .. _cmd.global.search:
 
 .. describe:: search
diff --git a/docs/source/usage/modes/namedqueries.rst b/docs/source/usage/modes/namedqueries.rst
new file mode 100644
index 00000000..ee0217a4
--- /dev/null
+++ b/docs/source/usage/modes/namedqueries.rst
@@ -0,0 +1,17 @@
+.. CAUTION: THIS FILE IS AUTO-GENERATED!
+
+
+Commands in `namedqueries` mode
+-------------------------------
+The following commands are available in namedqueries mode
+
+.. _cmd.namedqueries.select:
+
+.. describe:: select
+
+    search for messages with selected query
+
+    argument
+        additional filter to apply to query
+
+
diff --git a/docs/source/usage/modes/search.rst b/docs/source/usage/modes/search.rst
index bdfeb48b..43872eec 100644
--- a/docs/source/usage/modes/search.rst
+++ b/docs/source/usage/modes/search.rst
@@ -54,6 +54,20 @@ The following commands are available in search mode
     prompt to retag selected thread's or message's tags
 
 
+.. _cmd.search.savequery:
+
+.. describe:: savequery
+
+    store query string as a "named query" in the database. This falls back to the current search query in search buffers.
+
+    positional arguments
+        0: alias to use for query string
+        1: query string to store
+
+
+    optional arguments
+        :---no-flush: postpone a writeout to the index (Defaults to: 'True').
+
 .. _cmd.search.select:
 
 .. describe:: select