The text-markup package

[ Tags: bsd3, library, text ] [ Propose Tags ]

[Skip to Readme]

Properties

Versions 0.1
Change log CHANGELOG.md
Dependencies base (>=4.8 && <5.0), containers, text [details]
License BSD3
Copyright (c) 2016 Jonathan Daugherty
Author Jonathan Daugherty
Maintainer cygnus@foobox.com
Category Text
Home page https://github.com/jtdaugherty/text-markup/
Bug tracker https://github.com/jtdaugherty/text-markup/issues
Source repository head: git clone git://github.com/jtdaugherty/text-markup.git
Uploaded Mon Sep 5 19:50:30 UTC 2016 by JonathanDaugherty
Distributions NixOS:0.1
Downloads 69 total (7 in the last 30 days)
Rating 0.0 (0 ratings) [clear rating]
  • λ
  • λ
  • λ
Status Docs available [build log]
Last success reported on 2016-09-05 [all 1 reports]
Hackage Matrix CI

Modules

[Index]

Downloads

Maintainer's Corner

For package maintainers and hackage trustees


Readme for text-markup-0.1

[back to package description]

text-markup

This library provides a data structure for associating arbitrary metadata ("markup") with subsequences of text. The motivation for this library is to provide a tool for mapping text attributes to text sequences in terminal applications where we may want to perform many such mappings by searching text with regular expressions or using parsers to do syntax highlighting.

The main interface to the library is through three functions:

  • toMarkup - convert a Text into a Markup a,
  • markRegion - mark a region of the Text with a metadata value of type a, and
  • fromMarkup - recover the subsequences of the text with accompanying metadata.

For example,

> let m = toMarkup (T.pack "some@email.com 192.168.1.1 http://google.com/") Nothing
> fromMarkup $ markRegion 27 18 (Just "url")
             $ markRegion 15 11 (Just "ipv4")
             $ markRegion 0 14 (Just "e-mail") m
[ ("some@email.com"    , Just "e-mail")
, (" "                 , Nothing)
, ("192.168.1.1"       , Just "ipv4")
, (" "                 , Nothing)
, ("http://google.com/", Just "url")
]

Applying the same markup to adjacent regions results in a merge:

> let m = toMarkup (T.pack "foobar") Nothing
> fromMarkup $ markRegion 0 3 (Just "token") m
[("foo",Just "token"),("bar",Nothing)]
> fromMarkup $ markRegion 3 3 (Just "token")
             $ markRegion 0 3 (Just "token") m
[("foobar",Just "token")]