License	GPL-2
Maintainer	yi-devel@googlegroups.com
Stability	experimental
Portability	portable
Safe Haskell	None
Language	Haskell2010
Extensions	ScopedTypeVariables OverloadedStrings DeriveDataTypeable GeneralizedNewtypeDeriving ExplicitForAll

Yi.IReader

Description

This module defines a list type and operations on it; it further provides functions which write in and out the list. The goal is to make it easy for the user to store a large number of text buffers and cycle among them, making edits as she goes. The idea is inspired by "incremental reading", see http://en.wikipedia.org/wiki/Incremental_reading.

Synopsis

Documentation

type Article = ByteString #

TODO: Why ByteString?

newtype ArticleDB #

Constructors

ADB
Fields unADB :: Seq Article

Instances

Binary ArticleDB #
Methods put :: ArticleDB -> Put # get :: Get ArticleDB # putList :: [ArticleDB] -> Put #
Default ArticleDB #
Methods def :: ArticleDB #
YiVariable ArticleDB #

split :: ArticleDB -> (Article, ArticleDB) #

Take an ArticleDB, and return the first Article and an ArticleDB - *without* that article.

getLatestArticle :: ArticleDB -> Article #

Get the first article in the list. We use the list to express relative priority; the first is the most, the last least. We then just cycle through - every article gets equal time.

removeSetLast :: ArticleDB -> Article -> ArticleDB #

We remove the old first article, and we stick it on the end of the list using the presumably modified version.

shift :: Int -> ArticleDB -> ArticleDB #

insertArticle :: ArticleDB -> Article -> ArticleDB #

Insert a new article with top priority (that is, at the front of the list).

writeDB :: ArticleDB -> YiM () #

Serialize given ArticleDB out.

readDB :: YiM ArticleDB #

Read in database from getArticleDbFilename and then parse it into an ArticleDB.

oldDbNewArticle :: YiM (ArticleDB, Article) #

Returns the database as it exists on the disk, and the current Yi buffer contents. Note that the Default typeclass gives us an empty Seq. So first we try the buffer state in the hope we can avoid a very expensive read from disk, and if we find nothing (that is, if we get an empty Seq), only then do we call readDB.

setDisplayedArticle :: ArticleDB -> YiM () #

Given an ArticleDB, dump the scheduled article into the buffer (replacing previous contents).

nextArticle :: YiM () #

Go to next one. This ignores the buffer, but it doesn't remove anything from the database. However, the ordering does change.

deleteAndNextArticle :: YiM () #

Delete current article (the article as in the database), and go to next one.

saveAndNextArticle :: Int -> YiM () #

The main action. We fetch the old database, we fetch the modified article from the buffer, then we call the function updateSetLast which removes the first article and pushes our modified article to the end of the list.

saveAsNewArticle :: YiM () #

Assume the buffer is an entirely new article just imported this second, and save it. We don't want to use updateSetLast since that will erase an article.