#emacs #parser #orgmode

orgize

A Rust library for parsing orgmode files

6 releases

✓ Uses Rust 2018 edition

new 0.3.0 Aug 13, 2019
0.2.0 Jun 28, 2019
0.1.3 Feb 8, 2019

#38 in Parser tooling

Download history 2/week @ 2019-04-29 4/week @ 2019-05-06 9/week @ 2019-05-13 12/week @ 2019-05-20 4/week @ 2019-05-27 4/week @ 2019-06-03 10/week @ 2019-06-10 12/week @ 2019-06-17 38/week @ 2019-06-24 46/week @ 2019-07-01 15/week @ 2019-07-08 1/week @ 2019-07-15 6/week @ 2019-07-22 6/week @ 2019-07-29 23/week @ 2019-08-05

61 downloads per month

MIT license

159KB
4.5K SLoC

Orgize

Build Status Crates.io Document

A Rust library for parsing orgmode files.

Parse

To parse a orgmode string, simply invoking the Org::parse function:

use orgize::Org;

Org::parse("* DONE Title :tag:");

or Org::parse_with_config:

use orgize::{Org, ParseConfig};

Org::parse_with_config(
    "* TASK Title 1",
    &ParseConfig {
        // custom todo keywords
        todo_keywords: vec!["TASK".to_string()],
        ..Default::default()
    },
);

Iter

Org::iter function will returns an iteractor of Events, which is a simple wrapper of Element.

use orgize::Org;

for event in Org::parse("* DONE Title :tag:").iter() {
    // handling the event
}

Note: whether an element is container or not, it will appears twice in one loop. One as Event::Start(element), one as Event::End(element).

Render html

You can call the Org::html function to generate html directly, which uses the DefaultHtmlHandler internally:

use orgize::Org;

let mut writer = Vec::new();
Org::parse("* title\n*section*").html(&mut writer).unwrap();

assert_eq!(
    String::from_utf8(writer).unwrap(),
    "<main><h1>title</h1><section><p><b>section</b></p></section></main>"
);

Render html with custom HtmlHandler

To customize html rendering, simply implementing HtmlHandler trait and passing it to the Org::html_with_handler function.

The following code demonstrates how to add a id for every headline and return own error type while rendering.

use std::convert::From;
use std::io::{Error as IOError, Write};
use std::string::FromUtf8Error;

use orgize::export::{html::Escape, DefaultHtmlHandler, HtmlHandler};
use orgize::{Element, Org};
use slugify::slugify;

#[derive(Debug)]
enum MyError {
    IO(IOError),
    Heading,
    Utf8(FromUtf8Error),
}

// From<std::io::Error> trait is required for custom error type
impl From<IOError> for MyError {
    fn from(err: IOError) -> Self {
        MyError::IO(err)
    }
}

impl From<FromUtf8Error> for MyError {
    fn from(err: FromUtf8Error) -> Self {
        MyError::Utf8(err)
    }
}

struct MyHtmlHandler(DefaultHtmlHandler);

impl HtmlHandler<MyError> for MyHtmlHandler {
    fn start<W: Write>(&mut self, mut w: W, element: &Element<'_>) -> Result<(), MyError> {
        match element {
            Element::Title(title) => {
                if title.level > 6 {
                    return Err(MyError::Heading);
                } else {
                    write!(
                        w,
                        "<h{0}><a id=\"{1}\" href=\"#{1}\">",
                        title.level,
                        slugify!(title.raw),
                    )?;
                }
            }
            // fallthrough to default handler
            _ => self.0.start(w, element)?,
        }
        Ok(())
    }

    fn end<W: Write>(&mut self, mut w: W, element: &Element<'_>) -> Result<(), MyError> {
        match element {
            Element::Title(title) => {
                write!(w, "</a></h{}>", title.level,)?;
            }
            _ => self.0.end(w, element)?,
        }
        Ok(())
    }
}

fn main() -> Result<(), MyError> {
    let mut writer = Vec::new();
    Org::parse("* title\n*section*").html_with_handler(&mut writer, MyHtmlHandler(DefaultHtmlHandler))?;

    assert_eq!(
        String::from_utf8(writer)?,
        "<main><h1><a id=\"title\" href=\"#title\">title</a></h1>\
         <section><p><b>section</b></p></section></main>"
    );

    Ok(())
}

Note: as I mentioned above, each element will appears two times while iterating. And handler will silently ignores all end events from non-container elements.

So if you want to change how a non-container element renders, just redefine the start function and leave the end function unchanged.

Serde

Org struct have already implemented serde's Serialize trait. It means you can serialize it into any format supported by serde, such as json:

use orgize::Org;
use serde_json::{json, to_string};

let org = Org::parse("I 'm *bold*.");
println!("{}", to_string(&org).unwrap());

// {
//     "type": "document",
//     "children": [{
//         "type": "section",
//         "children": [{
//             "type": "paragraph",
//             "children":[{
//                 "type": "text",
//                 "value":"I 'm "
//             }, {
//                 "type": "bold",
//                 "children":[{
//                     "type": "text",
//                     "value": "bold"
//                 }]
//             }, {
//                 "type":"text",
//                 "value":"."
//             }]
//         }]
//     }]
// }

Features

By now, orgize provides two features:

  • ser: adds the ability to serialize Org and other elements using serde, enabled by default.

  • chrono: adds the ability to convert Datetime into chrono structs, disabled by default.

License

MIT

Dependencies

~1MB
~20K SLoC