Class: RDiscount

Inherits:
Object
  • Object
show all
Defined in:
lib/rdiscount.rb,
ext/rdiscount.c

Overview

Discount is an implementation of John Gruber's Markdown markup language in C. It implements all of the language as described in Markdown Syntax and passes the Markdown 1.0 test suite. The RDiscount extension makes the Discount processor available via a Ruby C Extension library.

Usage

RDiscount implements the basic protocol popularized by RedCloth and adopted by BlueCloth:

require 'rdiscount'
markdown = RDiscount.new("Hello World!")
puts markdown.to_html

Replacing BlueCloth

Inject RDiscount into your BlueCloth-using code by replacing your bluecloth require statements with the following:

begin
  require 'rdiscount'
  BlueCloth = RDiscount
rescue LoadError
  require 'bluecloth'
end

Constant Summary collapse

VERSION =
'1.3.5'

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(text, *extensions) ⇒ RDiscount

Create a RDiscount Markdown processor. The text argument should be a string containing Markdown text. Additional arguments may be supplied to set various processing options:

  • :smart - Enable SmartyPants processing.

  • :filter_styles - Do not output <style> tags.

  • :filter_html - Do not output any raw HTML tags included in the source text.

  • :fold_lines - RedCloth compatible line folding (not used).

NOTE: The :filter_styles extension is not yet implemented.


59
60
61
62
63
64
65
66
# File 'lib/rdiscount.rb', line 59

def initialize(text, *extensions)
  @text  = text
  @smart = nil
  @filter_styles = nil
  @filter_html = nil
  @fold_lines = nil
  extensions.each { |e| send("#{e}=", true) }
end

Instance Attribute Details

#filter_htmlObject

Do not output any raw HTML included in the source text.


39
40
41
# File 'lib/rdiscount.rb', line 39

def filter_html
  @filter_html
end

#filter_stylesObject

Do not output <style> tags included in the source text.


36
37
38
# File 'lib/rdiscount.rb', line 36

def filter_styles
  @filter_styles
end

#fold_linesObject

RedCloth compatible line folding – not used for Markdown but included for compatibility.


43
44
45
# File 'lib/rdiscount.rb', line 43

def fold_lines
  @fold_lines
end

#generate_tocObject

Enable Table Of Contents generation


46
47
48
# File 'lib/rdiscount.rb', line 46

def generate_toc
  @generate_toc
end

#smartObject

Set true to have smarty-like quote translation performed.


33
34
35
# File 'lib/rdiscount.rb', line 33

def smart
  @smart
end

#textObject (readonly)

Original Markdown formatted text.


30
31
32
# File 'lib/rdiscount.rb', line 30

def text
  @text
end

Instance Method Details

#to_html(*args) ⇒ Object


7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
# File 'ext/rdiscount.c', line 7

static VALUE
rb_rdiscount_to_html(int argc, VALUE *argv, VALUE self)
{
    /* grab char pointer to markdown input text */
    char *res;
    int szres;
    VALUE text = rb_funcall(self, rb_intern("text"), 0);
    VALUE buf = rb_str_buf_new(1024);
    Check_Type(text, T_STRING);

    int flags = rb_rdiscount__get_flags(self);

    MMIOT *doc = mkd_string(RSTRING_PTR(text), RSTRING_LEN(text), flags);

    if ( mkd_compile(doc, flags) ) {
        szres = mkd_document(doc, &res);

        if ( szres != EOF ) {
            rb_str_cat(buf, res, szres);
            rb_str_cat(buf, "\n", 1);
        }
    }
    mkd_cleanup(doc);

    return buf;
}

#toc_content(*args) ⇒ Object


34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
# File 'ext/rdiscount.c', line 34

static VALUE
rb_rdiscount_toc_content(int argc, VALUE *argv, VALUE self)
{
    char *res;
    int szres;

    int flags = rb_rdiscount__get_flags(self);

    /* grab char pointer to markdown input text */
    VALUE text = rb_funcall(self, rb_intern("text"), 0);
    Check_Type(text, T_STRING);

    /* allocate a ruby string buffer and wrap it in a stream */
    VALUE buf = rb_str_buf_new(4096);

    MMIOT *doc = mkd_string(RSTRING_PTR(text), RSTRING_LEN(text), flags);

    if ( mkd_compile(doc, flags) ) {
        szres = mkd_toc(doc, &res);

        if ( szres != EOF ) {
            rb_str_cat(buf, res, szres);
            rb_str_cat(buf, "\n", 1);
        }
    }
    mkd_cleanup(doc);

    return buf;
}