rdtool 0.6.23
Sign up to get free protection for your applications and to get access to all the features.
- data/COPYING.txt +674 -0
- data/Gemfile +9 -0
- data/HISTORY +284 -0
- data/LICENSE.txt +58 -0
- data/MANIFEST +89 -0
- data/README.html +44 -0
- data/README.ja.html +46 -0
- data/README.rd +52 -0
- data/README.rd.ja +54 -0
- data/Rakefile +29 -0
- data/TODO +15 -0
- data/VERSION +1 -0
- data/bin/rd2 +281 -0
- data/bin/rdswap.rb +207 -0
- data/doc/rd-draft.rd +479 -0
- data/doc/rd-draft.rd.ja +487 -0
- data/lib/rd/block-element.rb +114 -0
- data/lib/rd/complex-list-item.rb +65 -0
- data/lib/rd/desclist.rb +55 -0
- data/lib/rd/document-struct.rb +46 -0
- data/lib/rd/dot.rd2rc +18 -0
- data/lib/rd/element.rb +160 -0
- data/lib/rd/filter.rb +255 -0
- data/lib/rd/inline-element.rb +233 -0
- data/lib/rd/labeled-element.rb +14 -0
- data/lib/rd/list.rb +57 -0
- data/lib/rd/loose-struct.rb +11 -0
- data/lib/rd/methodlist.rb +57 -0
- data/lib/rd/output-format-visitor.rb +28 -0
- data/lib/rd/package.rb +4 -0
- data/lib/rd/parser-util.rb +14 -0
- data/lib/rd/post-install +1 -0
- data/lib/rd/rbl-file.rb +69 -0
- data/lib/rd/rbl-suite.rb +37 -0
- data/lib/rd/rd-struct.rb +86 -0
- data/lib/rd/rd2html-lib.rb +490 -0
- data/lib/rd/rd2html-opt.rb +67 -0
- data/lib/rd/rd2man-lib.rb +241 -0
- data/lib/rd/rd2rdo-lib.rb +19 -0
- data/lib/rd/rd2rmi-lib.rb +32 -0
- data/lib/rd/rdblockparser.ry +518 -0
- data/lib/rd/rdblockparser.tab.rb +1050 -0
- data/lib/rd/rdfmt.rb +15 -0
- data/lib/rd/rdinlineparser.ry +503 -0
- data/lib/rd/rdinlineparser.tab.rb +1243 -0
- data/lib/rd/rdvisitor.rb +214 -0
- data/lib/rd/reference-resolver.rb +114 -0
- data/lib/rd/search-file.rb +14 -0
- data/lib/rd/tree.rb +103 -0
- data/lib/rd/version.rb +39 -0
- data/lib/rd/visitor.rb +86 -0
- data/makerdtool.rb +75 -0
- data/setup.rb +1596 -0
- data/test.rb +33 -0
- data/test/data/includee1.html +1 -0
- data/test/data/includee2.html +1 -0
- data/test/data/includee3.nothtml +1 -0
- data/test/data/includee4.xhtml +0 -0
- data/test/data/label.rbl +2 -0
- data/test/data/label2.rbl +2 -0
- data/test/data/sub/includee2.html +1 -0
- data/test/data/sub/includee4.html +0 -0
- data/test/dummy-observer.rb +6 -0
- data/test/dummy.rb +33 -0
- data/test/temp-dir.rb +19 -0
- data/test/test-block-parser.rb +46 -0
- data/test/test-desclist-item.rb +219 -0
- data/test/test-document-element.rb +46 -0
- data/test/test-document-struct.rb +66 -0
- data/test/test-element.rb +46 -0
- data/test/test-headline.rb +80 -0
- data/test/test-inline-parser.rb +46 -0
- data/test/test-list-item.rb +54 -0
- data/test/test-list.rb +53 -0
- data/test/test-methodlist-item.rb +73 -0
- data/test/test-nonterminal-element.rb +170 -0
- data/test/test-nonterminal-inline.rb +33 -0
- data/test/test-output-format-visitor.rb +48 -0
- data/test/test-parser-util.rb +41 -0
- data/test/test-rbl-file.rb +156 -0
- data/test/test-rbl-suite.rb +43 -0
- data/test/test-rd2html-lib.rb +496 -0
- data/test/test-rdtree.rb +17 -0
- data/test/test-rdvisitor.rb +29 -0
- data/test/test-reference-resolver.rb +202 -0
- data/test/test-reference.rb +132 -0
- data/test/test-search-file.rb +22 -0
- data/test/test-terminal-inline.rb +41 -0
- data/test/test-textblock.rb +44 -0
- data/test/test-tree.rb +82 -0
- data/test/test-version.rb +57 -0
- data/test/test-visitor.rb +230 -0
- data/utils/rd-mode.el +425 -0
- metadata +203 -0
@@ -0,0 +1,44 @@
|
|
1
|
+
require 'test/unit'
|
2
|
+
|
3
|
+
require 'rd/block-element'
|
4
|
+
require 'rd/inline-element'
|
5
|
+
require 'rd/rd-struct'
|
6
|
+
|
7
|
+
include RD
|
8
|
+
|
9
|
+
class TestTextBlock < Test::Unit::TestCase
|
10
|
+
def setup
|
11
|
+
@p = TextBlock.new
|
12
|
+
@c1 = StringElement.new "string"
|
13
|
+
@c2 = Emphasis.new
|
14
|
+
@c21 = StringElement.new "in emphasis"
|
15
|
+
@c2.add_child_under_document_struct(@c21, DocumentStructure::RD)
|
16
|
+
@c3 = Code.new
|
17
|
+
@c31 = StringElement.new "code"
|
18
|
+
@c32 = Var.new
|
19
|
+
@c321 = StringElement.new "var"
|
20
|
+
@c32.add_child_under_document_struct(@c321, DocumentStructure::RD)
|
21
|
+
@c3.add_children_under_document_struct([@c31, @c32], DocumentStructure::RD)
|
22
|
+
@c4 = Verb.new "verb"
|
23
|
+
@p.add_children_under_document_struct([@c1, @c2, @c3, @c4],
|
24
|
+
DocumentStructure::RD)
|
25
|
+
end
|
26
|
+
|
27
|
+
def test_each_child
|
28
|
+
exp = [@c1, @c2, @c3, @c4]
|
29
|
+
i = 0
|
30
|
+
@p.each_child do |b|
|
31
|
+
assert_equal(exp[i], b)
|
32
|
+
i += 1
|
33
|
+
end
|
34
|
+
end
|
35
|
+
|
36
|
+
def test_each_element
|
37
|
+
exp = [@p, @c1, @c2, @c21, @c3, @c31, @c32, @c321, @c4]
|
38
|
+
i = 0
|
39
|
+
@p.each_element do |b|
|
40
|
+
assert_equal(exp[i], b)
|
41
|
+
i += 1
|
42
|
+
end
|
43
|
+
end
|
44
|
+
end
|
data/test/test-tree.rb
ADDED
@@ -0,0 +1,82 @@
|
|
1
|
+
require 'test/unit'
|
2
|
+
|
3
|
+
require 'rd/tree'
|
4
|
+
require 'rd/element'
|
5
|
+
require 'rd/rd-struct'
|
6
|
+
require 'rd/loose-struct'
|
7
|
+
|
8
|
+
include RD
|
9
|
+
|
10
|
+
class TestTree < Test::Unit::TestCase
|
11
|
+
def test_new_with_document_struct
|
12
|
+
tr = Tree.new_with_document_struct(DocumentStructure::RD, ["test/data"])
|
13
|
+
assert_equal(nil, tr.root)
|
14
|
+
assert_equal(["test/data"], tr.include_paths)
|
15
|
+
end
|
16
|
+
|
17
|
+
def test_set_root
|
18
|
+
tr = Tree.new_with_document_struct(DocumentStructure::RD)
|
19
|
+
de = DocumentElement.new
|
20
|
+
tr.set_root(de)
|
21
|
+
assert_equal(de, tr.root)
|
22
|
+
assert_equal(tr, de.tree)
|
23
|
+
end
|
24
|
+
|
25
|
+
def test_each_element
|
26
|
+
tr = Tree.new_with_document_struct(DocumentStructure::RD)
|
27
|
+
de = DocumentElement.new
|
28
|
+
tr.root = de
|
29
|
+
exp = [de]
|
30
|
+
i = 0
|
31
|
+
tr.each_element do |b|
|
32
|
+
assert_equal(exp[i], b)
|
33
|
+
end
|
34
|
+
|
35
|
+
tr_emp = Tree.new_with_document_struct(DocumentStructure::RD)
|
36
|
+
assert_equal(nil, tr_emp.each_element)
|
37
|
+
end
|
38
|
+
|
39
|
+
def test_make_root
|
40
|
+
tr = Tree.new_with_document_struct(DocumentStructure::RD)
|
41
|
+
res = tr.make_root
|
42
|
+
assert(tr.root)
|
43
|
+
assert_equal(tr.root, res)
|
44
|
+
|
45
|
+
tr2 = Tree.new_with_document_struct(DocumentStructure::RD)
|
46
|
+
res2 = tr2.make_root do
|
47
|
+
new TextBlock
|
48
|
+
end
|
49
|
+
assert(tr2.root)
|
50
|
+
assert_equal("<RD::DocumentElement>\n <RD::TextBlock>", tr2.root.inspect)
|
51
|
+
assert_equal(tr2.root, res2)
|
52
|
+
end
|
53
|
+
|
54
|
+
def test_check_valid
|
55
|
+
tr = Tree.new_with_document_struct(DocumentStructure::RD)
|
56
|
+
de = DocumentElement.new
|
57
|
+
tr.root = de
|
58
|
+
de.build do
|
59
|
+
new Headline, 1 do
|
60
|
+
new StringElement, "label"
|
61
|
+
end
|
62
|
+
new TextBlock do
|
63
|
+
new Emphasis do
|
64
|
+
new StringElement, "emphasis"
|
65
|
+
end
|
66
|
+
end
|
67
|
+
end
|
68
|
+
assert_equal(true, tr.check_valid)
|
69
|
+
|
70
|
+
tr_fail = Tree.new_with_document_struct(DocumentStructure::RD)
|
71
|
+
de_fail = DocumentElement.new
|
72
|
+
tr_fail.root = de_fail
|
73
|
+
tb_fail = TextBlock.new
|
74
|
+
tb_fail.build(DocumentStructure::LOOSE) do
|
75
|
+
new Headline, 1
|
76
|
+
end
|
77
|
+
de_fail.add_child(tb_fail)
|
78
|
+
assert_raises(RuntimeError) do
|
79
|
+
tr_fail.check_valid
|
80
|
+
end
|
81
|
+
end
|
82
|
+
end
|
@@ -0,0 +1,57 @@
|
|
1
|
+
require 'test/unit'
|
2
|
+
|
3
|
+
require 'rd/version'
|
4
|
+
|
5
|
+
include RD
|
6
|
+
|
7
|
+
class TestVersion < Test::Unit::TestCase
|
8
|
+
def test_s_new_from_version_string
|
9
|
+
ver011 = Version.new_from_version_string("name", "$Version: 0.1.1$") # "
|
10
|
+
assert_equal("name", ver011.name)
|
11
|
+
assert_equal(0, ver011.major)
|
12
|
+
assert_equal(1, ver011.minor)
|
13
|
+
assert_equal(1, ver011.patch_level)
|
14
|
+
|
15
|
+
ver0101 = Version.new_from_version_string("name", "$Version: 0.10.1$") #"
|
16
|
+
assert_equal(0, ver0101.major)
|
17
|
+
assert_equal(10, ver0101.minor)
|
18
|
+
assert_equal(1, ver0101.patch_level)
|
19
|
+
|
20
|
+
ver01 = Version.new_from_version_string("name", "$Version: 0.1$") # "
|
21
|
+
assert_equal(0, ver01.major)
|
22
|
+
assert_equal(1, ver01.minor)
|
23
|
+
assert_equal(nil, ver01.patch_level)
|
24
|
+
|
25
|
+
ver0 = Version.new_from_version_string("name", "$Version: 0$") # "
|
26
|
+
assert_equal(0, ver0.major)
|
27
|
+
assert_equal(nil, ver0.minor)
|
28
|
+
assert_equal(nil, ver0.patch_level)
|
29
|
+
|
30
|
+
ver011_2 = Version.new_from_version_string("name", "0.1.1") # "
|
31
|
+
assert_equal("name", ver011_2.name)
|
32
|
+
assert_equal(0, ver011_2.major)
|
33
|
+
assert_equal(1, ver011_2.minor)
|
34
|
+
assert_equal(1, ver011_2.patch_level)
|
35
|
+
end
|
36
|
+
|
37
|
+
def test_s_clean_up_version_string
|
38
|
+
assert_equal("0.1.1",
|
39
|
+
Version.clean_up_version_string("$Version: 0.1.1$")) #"
|
40
|
+
assert_equal("0.1.1",
|
41
|
+
Version.clean_up_version_string("0.1.1"))
|
42
|
+
assert_equal("", Version.clean_up_version_string("$Version$")) # "
|
43
|
+
end
|
44
|
+
|
45
|
+
def test_to_s
|
46
|
+
ver011 = Version.new("name", 0, 1, 1)
|
47
|
+
assert_equal("name 0.1.1", ver011.to_s)
|
48
|
+
ver0101 = Version.new("name", 0, 10, 1)
|
49
|
+
assert_equal("name 0.10.1", ver0101.to_s)
|
50
|
+
|
51
|
+
ver01 = Version.new("name", 0, 1, nil)
|
52
|
+
assert_equal("name 0.1", ver01.to_s)
|
53
|
+
|
54
|
+
ver0 = Version.new("name", 0, nil, nil)
|
55
|
+
assert_equal("name 0", ver0.to_s)
|
56
|
+
end
|
57
|
+
end
|
@@ -0,0 +1,230 @@
|
|
1
|
+
require 'test/unit'
|
2
|
+
|
3
|
+
require 'rd/visitor'
|
4
|
+
require 'rd/block-element'
|
5
|
+
require 'rd/list'
|
6
|
+
require 'rd/desclist'
|
7
|
+
require 'rd/methodlist'
|
8
|
+
require 'rd/inline-element'
|
9
|
+
require 'rd/tree'
|
10
|
+
require 'rd/rd-struct'
|
11
|
+
require 'dummy'
|
12
|
+
|
13
|
+
include RD
|
14
|
+
|
15
|
+
DummyStruct.define_relationship(NonterminalElement, DummyElement)
|
16
|
+
|
17
|
+
class TestVisitor < Test::Unit::TestCase
|
18
|
+
def setup
|
19
|
+
@vis = DummyVisitor.new
|
20
|
+
end
|
21
|
+
|
22
|
+
def test_visit_children
|
23
|
+
el = TextBlock.new
|
24
|
+
add_2_children(el)
|
25
|
+
assert_equal(["dummy", "dummy"], @vis.visit_children(el))
|
26
|
+
|
27
|
+
empty = TextBlock.new
|
28
|
+
assert_equal([], @vis.visit_children(empty))
|
29
|
+
end
|
30
|
+
|
31
|
+
def test_visit_DocumentElement
|
32
|
+
el = DocumentElement.new
|
33
|
+
add_2_children(el)
|
34
|
+
assert_equal(["apply_to_DocumentElement", [el, ["dummy", "dummy"]]],
|
35
|
+
@vis.visit_DocumentElement(el))
|
36
|
+
end
|
37
|
+
|
38
|
+
def test_visit_Headline
|
39
|
+
el = Headline.new(1)
|
40
|
+
add_2_children(el)
|
41
|
+
assert_equal(["apply_to_Headline", [el, ["dummy", "dummy"]]],
|
42
|
+
@vis.visit_Headline(el))
|
43
|
+
end
|
44
|
+
|
45
|
+
def test_visit_Include
|
46
|
+
el = Include.new "include"
|
47
|
+
assert_equal(["apply_to_Include", [el]],
|
48
|
+
@vis.visit_Include(el))
|
49
|
+
end
|
50
|
+
|
51
|
+
def test_visit_TextBlock
|
52
|
+
el = TextBlock.new
|
53
|
+
add_2_children(el)
|
54
|
+
assert_equal(["apply_to_TextBlock", [el, ["dummy", "dummy"]]],
|
55
|
+
@vis.visit_TextBlock(el))
|
56
|
+
end
|
57
|
+
|
58
|
+
def test_visit_Verbatim
|
59
|
+
el = Verbatim.new "Verbatim"
|
60
|
+
assert_equal(["apply_to_Verbatim", [el]],
|
61
|
+
@vis.visit_Verbatim(el))
|
62
|
+
end
|
63
|
+
|
64
|
+
def test_visit_ItemList
|
65
|
+
el = ItemList.new
|
66
|
+
add_2_children(el)
|
67
|
+
assert_equal(["apply_to_ItemList", [el, ["dummy", "dummy"]]],
|
68
|
+
@vis.visit_ItemList(el))
|
69
|
+
end
|
70
|
+
|
71
|
+
def test_visit_EnumList
|
72
|
+
el = EnumList.new
|
73
|
+
add_2_children(el)
|
74
|
+
assert_equal(["apply_to_EnumList", [el, ["dummy", "dummy"]]],
|
75
|
+
@vis.visit_EnumList(el))
|
76
|
+
end
|
77
|
+
|
78
|
+
def test_visit_DescList
|
79
|
+
el = DescList.new
|
80
|
+
add_2_children(el)
|
81
|
+
assert_equal(["apply_to_DescList", [el, ["dummy", "dummy"]]],
|
82
|
+
@vis.visit_DescList(el))
|
83
|
+
end
|
84
|
+
|
85
|
+
def test_visit_MethodList
|
86
|
+
el = MethodList.new
|
87
|
+
add_2_children(el)
|
88
|
+
assert_equal(["apply_to_MethodList", [el, ["dummy", "dummy"]]],
|
89
|
+
@vis.visit_MethodList(el))
|
90
|
+
end
|
91
|
+
|
92
|
+
def test_visit_ItemListItem
|
93
|
+
el = ItemListItem.new
|
94
|
+
add_2_children(el)
|
95
|
+
assert_equal(["apply_to_ItemListItem", [el, ["dummy", "dummy"]]],
|
96
|
+
@vis.visit_ItemListItem(el))
|
97
|
+
end
|
98
|
+
|
99
|
+
def test_visit_EnumListItem
|
100
|
+
el = EnumListItem.new
|
101
|
+
add_2_children(el)
|
102
|
+
assert_equal(["apply_to_EnumListItem", [el, ["dummy", "dummy"]]],
|
103
|
+
@vis.visit_EnumListItem(el))
|
104
|
+
end
|
105
|
+
|
106
|
+
def test_visit_DescListItem
|
107
|
+
el = DescListItem.new
|
108
|
+
el.set_term_under_document_struct(DummyElement.new, DummyStruct)
|
109
|
+
add_2_children(el)
|
110
|
+
assert_equal(["apply_to_DescListItem", [el, "dummy", ["dummy", "dummy"]]],
|
111
|
+
@vis.visit_DescListItem(el))
|
112
|
+
|
113
|
+
empty = DescListItem.new
|
114
|
+
empty.set_term_under_document_struct(DummyElement.new, DummyStruct)
|
115
|
+
assert_equal(["apply_to_DescListItem", [empty, "dummy", []]],
|
116
|
+
@vis.visit_DescListItem(empty))
|
117
|
+
end
|
118
|
+
|
119
|
+
def test_visit_DescListItemTerm
|
120
|
+
el = DescListItem::Term.new
|
121
|
+
add_2_children(el)
|
122
|
+
assert_equal(["apply_to_DescListItemTerm", [el, ["dummy", "dummy"]]],
|
123
|
+
@vis.visit_DescListItemTerm(el))
|
124
|
+
end
|
125
|
+
|
126
|
+
def test_visit_MethodListItem
|
127
|
+
el = MethodListItem.new
|
128
|
+
el.set_term_under_document_struct(DummyElement.new, DummyStruct)
|
129
|
+
add_2_children(el)
|
130
|
+
assert_equal(["apply_to_MethodListItem", [el, "dummy", ["dummy", "dummy"]]],
|
131
|
+
@vis.visit_MethodListItem(el))
|
132
|
+
|
133
|
+
empty = MethodListItem.new
|
134
|
+
empty.set_term_under_document_struct(DummyElement.new, DummyStruct)
|
135
|
+
assert_equal(["apply_to_MethodListItem", [empty, "dummy", []]],
|
136
|
+
@vis.visit_MethodListItem(empty))
|
137
|
+
end
|
138
|
+
|
139
|
+
def test_visit_MethodListItemTerm
|
140
|
+
el = MethodListItem::Term.new
|
141
|
+
assert_equal(["apply_to_MethodListItemTerm", [el]],
|
142
|
+
@vis.visit_MethodListItemTerm(el))
|
143
|
+
end
|
144
|
+
|
145
|
+
def test_visit_StringElement
|
146
|
+
el = StringElement.new "string"
|
147
|
+
assert_equal(["apply_to_StringElement", [el]], @vis.visit_StringElement(el))
|
148
|
+
end
|
149
|
+
|
150
|
+
def test_visit_Verb
|
151
|
+
el = Verb.new "string"
|
152
|
+
assert_equal(["apply_to_Verb", [el]], @vis.visit_Verb(el))
|
153
|
+
end
|
154
|
+
|
155
|
+
def test_visit_Emphasis
|
156
|
+
el = Emphasis.new
|
157
|
+
add_2_children(el)
|
158
|
+
assert_equal(["apply_to_Emphasis", [el, ["dummy", "dummy"]]],
|
159
|
+
@vis.visit_Emphasis(el))
|
160
|
+
end
|
161
|
+
|
162
|
+
def test_visit_Code
|
163
|
+
el = Code.new
|
164
|
+
add_2_children(el)
|
165
|
+
assert_equal(["apply_to_Code", [el, ["dummy", "dummy"]]],
|
166
|
+
@vis.visit_Code(el))
|
167
|
+
end
|
168
|
+
|
169
|
+
def test_visit_Var
|
170
|
+
el = Var.new
|
171
|
+
add_2_children(el)
|
172
|
+
assert_equal(["apply_to_Var", [el, ["dummy", "dummy"]]],
|
173
|
+
@vis.visit_Var(el))
|
174
|
+
end
|
175
|
+
|
176
|
+
def test_visit_Keyboard
|
177
|
+
el = Keyboard.new
|
178
|
+
add_2_children(el)
|
179
|
+
assert_equal(["apply_to_Keyboard", [el, ["dummy", "dummy"]]],
|
180
|
+
@vis.visit_Keyboard(el))
|
181
|
+
end
|
182
|
+
|
183
|
+
def test_visit_Index
|
184
|
+
el = Index.new
|
185
|
+
add_2_children(el)
|
186
|
+
assert_equal(["apply_to_Index", [el, ["dummy", "dummy"]]],
|
187
|
+
@vis.visit_Index(el))
|
188
|
+
end
|
189
|
+
|
190
|
+
def test_visit_Footnote
|
191
|
+
el = Footnote.new
|
192
|
+
add_2_children(el)
|
193
|
+
assert_equal(["apply_to_Footnote", [el, ["dummy", "dummy"]]],
|
194
|
+
@vis.visit_Footnote(el))
|
195
|
+
end
|
196
|
+
|
197
|
+
def test_visit_Reference
|
198
|
+
el = Reference.new(Reference::RDLabel.new("label"))
|
199
|
+
add_2_children(el)
|
200
|
+
assert_equal(["apply_to_Reference_with_RDLabel", [el, ["dummy", "dummy"]]],
|
201
|
+
@vis.visit_Reference(el))
|
202
|
+
|
203
|
+
empty = Reference.new(Reference::RDLabel.new("label"))
|
204
|
+
assert_equal(["apply_to_Reference_with_RDLabel", [empty, []]],
|
205
|
+
@vis.visit_Reference(empty))
|
206
|
+
|
207
|
+
url_reference = Reference.new(Reference::URL.new("url"))
|
208
|
+
add_2_children(url_reference)
|
209
|
+
assert_equal(["apply_to_Reference_with_URL",
|
210
|
+
[url_reference, ["dummy", "dummy"]]],
|
211
|
+
@vis.visit_Reference(url_reference))
|
212
|
+
|
213
|
+
# OldStyleDummyVisitor#apply_to_Reference_with_RDLabel is not implemented.
|
214
|
+
# So, #apply_to_reference is called instead of it.
|
215
|
+
old_visitor = OldStyleDummyVisitor.new
|
216
|
+
assert_equal(["apply_to_Reference", [el, ["dummy", "dummy"]]],
|
217
|
+
old_visitor.visit_Reference(el))
|
218
|
+
end
|
219
|
+
|
220
|
+
def add_2_children(el)
|
221
|
+
el.add_children_under_document_struct([DummyElement.new, DummyElement.new],
|
222
|
+
DummyStruct)
|
223
|
+
end
|
224
|
+
end
|
225
|
+
|
226
|
+
class OldStyleDummyVisitor < Visitor
|
227
|
+
def apply_to_Reference(*args)
|
228
|
+
["apply_to_Reference", args]
|
229
|
+
end
|
230
|
+
end
|
data/utils/rd-mode.el
ADDED
@@ -0,0 +1,425 @@
|
|
1
|
+
;;;
|
2
|
+
;;; rd-mode.el
|
3
|
+
;;; Major mode for RD editing
|
4
|
+
;;;
|
5
|
+
;;; NOTE: experimental.
|
6
|
+
|
7
|
+
;; Copyright (C) 1999 Koji Arai, Toshiro Kuwabara.
|
8
|
+
|
9
|
+
;; Author: Koji Arai, Toshiro Kuwabara
|
10
|
+
;; Created: Sat Nov 27 00:08:12 1999
|
11
|
+
|
12
|
+
;; This file is not part of GNU Emacs, but the same permissions apply.
|
13
|
+
|
14
|
+
;; GNU Emacs is free software; you can redistribute it and/or modify
|
15
|
+
;; it under the terms of the GNU General Public License as published by
|
16
|
+
;; the Free Software Foundation; either version 2, or (at your option)
|
17
|
+
;; any later version.
|
18
|
+
|
19
|
+
;; GNU Emacs is distributed in the hope that it will be useful,
|
20
|
+
;; but WITHOUT ANY WARRANTY; without even the implied warranty of
|
21
|
+
;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
22
|
+
;; GNU General Public License for more details.
|
23
|
+
|
24
|
+
;; You should have received a copy of the GNU General Public License
|
25
|
+
;; along with GNU Emacs; see the file COPYING. If not, write to the
|
26
|
+
;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
|
27
|
+
;; Boston, MA 02111-1307, USA.
|
28
|
+
|
29
|
+
;; Settings:
|
30
|
+
;;
|
31
|
+
;; add below lines in your ~/.emacs
|
32
|
+
;;
|
33
|
+
;; (global-font-lock-mode 1 t)
|
34
|
+
;; (autoload 'rd-mode "rd-mode" "major mode for ruby document formatter RD" t)
|
35
|
+
;; (add-to-list 'auto-mode-alist '("\\.rd$" . rd-mode))
|
36
|
+
|
37
|
+
(require 'derived)
|
38
|
+
|
39
|
+
(defvar rd-use-prompt-when-insertion-p nil
|
40
|
+
"Whether to use prompt when inserting inline.")
|
41
|
+
|
42
|
+
(defvar rd-selective-display-ellipses t
|
43
|
+
"*Displays ellipses in RD-mode if non-nil")
|
44
|
+
|
45
|
+
(defvar rd-mode-hook nil
|
46
|
+
"Hooks run when entering `rd-mode' major mode")
|
47
|
+
|
48
|
+
(define-derived-mode rd-mode text-mode "RD"
|
49
|
+
"Major mode for RD editing.
|
50
|
+
\\{rd-mode-map}"
|
51
|
+
(make-local-variable 'paragraph-separate)
|
52
|
+
(setq paragraph-separate "=+\\|\\++\\|[ \t\n\^L]*$")
|
53
|
+
(make-local-variable 'paragraph-start)
|
54
|
+
(setq paragraph-start "=+\\|\\++\\|[ \t\n\^L]")
|
55
|
+
(make-local-variable 'require-final-newline)
|
56
|
+
(setq require-final-newline t)
|
57
|
+
(make-local-variable 'font-lock-defaults)
|
58
|
+
(setq font-lock-defaults '((rd-font-lock-keywords) t nil))
|
59
|
+
(make-local-variable 'font-lock-keywords)
|
60
|
+
(setq font-lock-keywords rd-font-lock-keywords)
|
61
|
+
(make-local-variable 'outline-regexp)
|
62
|
+
(setq outline-regexp "^\\(=+\\)")
|
63
|
+
(outline-minor-mode t)
|
64
|
+
(add-hook (make-local-variable 'write-contents-hooks) 'rd-strip-cr-on-top)
|
65
|
+
(add-hook (make-local-variable 'after-save-hook) 'rd-rehide-endline)
|
66
|
+
(rd-hide-other-block-all)
|
67
|
+
(rd-setup-keys)
|
68
|
+
(setq indent-tabs-mode nil)
|
69
|
+
(run-hooks 'rd-mode-hook)
|
70
|
+
)
|
71
|
+
|
72
|
+
(defvar rd-heading1-face 'font-lock-keyword-face)
|
73
|
+
(defvar rd-heading2-face 'font-lock-type-face)
|
74
|
+
(defvar rd-heading3-face 'font-lock-variable-name-face)
|
75
|
+
(defvar rd-heading4-face 'font-lock-comment-face)
|
76
|
+
(defvar rd-emphasis-face 'font-lock-function-name-face)
|
77
|
+
(defvar rd-keyboard-face 'font-lock-function-name-face)
|
78
|
+
(defvar rd-variable-face 'font-lock-function-name-face)
|
79
|
+
(defvar rd-verbatim-face 'font-lock-function-name-face)
|
80
|
+
(defvar rd-term-face 'font-lock-function-name-face)
|
81
|
+
(defvar rd-footnote-face 'font-lock-function-name-face)
|
82
|
+
(defvar rd-link-face 'font-lock-function-name-face)
|
83
|
+
(defvar rd-code-face 'font-lock-function-name-face)
|
84
|
+
(defvar rd-description-face 'font-lock-constant-face)
|
85
|
+
|
86
|
+
(defvar rd-font-lock-keywords
|
87
|
+
(list
|
88
|
+
'("^= .*$"
|
89
|
+
0 rd-heading1-face)
|
90
|
+
'("^== .*$"
|
91
|
+
0 rd-heading2-face)
|
92
|
+
'("^=== .*$"
|
93
|
+
0 rd-heading3-face)
|
94
|
+
'("^=====* .*$"
|
95
|
+
0 rd-heading4-face)
|
96
|
+
'("((\\*[^*]*\\*+\\([^)*][^%]*\\*+\\)*))" ; ((* ... *))
|
97
|
+
0 rd-emphasis-face)
|
98
|
+
'("((%[^%]*%+\\([^)%][^%]*%+\\)*))" ; ((% ... %))
|
99
|
+
0 rd-keyboard-face)
|
100
|
+
'("((|[^|]*|+\\([^)|][^|]*|+\\)*))" ; ((| ... |))
|
101
|
+
0 rd-variable-face)
|
102
|
+
'("(('[^']*'+\\([^)'][^']*'+\\)*))" ; ((' ... '))
|
103
|
+
0 rd-verbatim-face)
|
104
|
+
'("((:[^:]*:+\\([^):][^:]*:+\\)*))" ; ((: ... :))
|
105
|
+
0 rd-term-face)
|
106
|
+
'("((-[^-]*-+\\([^)-][^-]*-+\\)*))" ; ((- ... -))
|
107
|
+
0 rd-footnote-face)
|
108
|
+
'("((<[^>]*>+\\([^)>][^>]*>+\\)*))" ; ((< ... >))
|
109
|
+
0 rd-link-face)
|
110
|
+
'("(({[^}]*}+\\([^)}][^}]*}+\\)*))" ; (({ ... }))
|
111
|
+
0 rd-code-face)
|
112
|
+
'("^:.*$"
|
113
|
+
0 rd-description-face)
|
114
|
+
))
|
115
|
+
|
116
|
+
(defun rd-setup-keys ()
|
117
|
+
(interactive)
|
118
|
+
(define-key rd-mode-map "\t" 'rd-indent-line)
|
119
|
+
(define-key rd-mode-map "\C-j" 'rd-newline-and-indent)
|
120
|
+
(define-key rd-mode-map "\C-c\C-v" 'rd-cite-region)
|
121
|
+
(define-key rd-mode-map "\C-c\C-ie" 'rd-insert-emphasis)
|
122
|
+
(define-key rd-mode-map "\C-c\C-ic" 'rd-insert-code)
|
123
|
+
(define-key rd-mode-map "\C-c\C-iv" 'rd-insert-var)
|
124
|
+
(define-key rd-mode-map "\C-c\C-ik" 'rd-insert-keyboard)
|
125
|
+
(define-key rd-mode-map "\C-c\C-ii" 'rd-insert-index)
|
126
|
+
(define-key rd-mode-map "\C-c\C-ir" 'rd-insert-ref)
|
127
|
+
(define-key rd-mode-map "\C-c\C-iu" 'rd-insert-reftourl)
|
128
|
+
(define-key rd-mode-map "\C-c\C-if" 'rd-insert-footnote)
|
129
|
+
(define-key rd-mode-map "\C-c\C-ib" 'rd-insert-verb)
|
130
|
+
(define-key rd-mode-map "\C-c\C-y" 'rd-yank-as-url)
|
131
|
+
(define-key rd-mode-map "\C-c\M-y" 'rd-yank-pop-as-url)
|
132
|
+
(define-key rd-mode-map "\C-c\C-u" 'rd-insert-url)
|
133
|
+
(define-key rd-mode-map "\M-\C-m" 'rd-intelligent-newline))
|
134
|
+
|
135
|
+
(defun rd-strip-cr-on-top ()
|
136
|
+
(save-excursion
|
137
|
+
(widen)
|
138
|
+
(goto-char (point-min))
|
139
|
+
(let ((mod (buffer-modified-p)))
|
140
|
+
(while (re-search-forward "^\r=end\\>" nil t)
|
141
|
+
(beginning-of-line)
|
142
|
+
(delete-char 1)
|
143
|
+
(forward-line))
|
144
|
+
(set-buffer-modified-p mod)))
|
145
|
+
nil)
|
146
|
+
|
147
|
+
(defun rd-rehide-endline ()
|
148
|
+
(save-excursion
|
149
|
+
(widen)
|
150
|
+
(goto-char (point-min))
|
151
|
+
(let ((mod (buffer-modified-p)))
|
152
|
+
(while (re-search-forward "^=end\\>.*\r" nil t)
|
153
|
+
(beginning-of-line)
|
154
|
+
(insert "\r")
|
155
|
+
(forward-line))
|
156
|
+
(set-buffer-modified-p mod))))
|
157
|
+
|
158
|
+
(defun rd-hide-other-block ()
|
159
|
+
"Hides following lines not in RD format."
|
160
|
+
(interactive)
|
161
|
+
(let (end (mod (buffer-modified-p)))
|
162
|
+
(save-excursion
|
163
|
+
(widen)
|
164
|
+
(and (setq end (re-search-forward "^=begin\\>" nil t))
|
165
|
+
(re-search-backward "^=end\\>" nil t))
|
166
|
+
(insert "\r")
|
167
|
+
(while (search-forward "\n" end t)
|
168
|
+
(replace-match "\r" t t)))
|
169
|
+
(set-buffer-modified-p mod))
|
170
|
+
(setq selective-display t
|
171
|
+
selective-display-ellipses rd-selective-display-ellipses))
|
172
|
+
|
173
|
+
(defun rd-hide-other-block-all ()
|
174
|
+
"Hides all lines not in RD format."
|
175
|
+
(interactive)
|
176
|
+
(let (beg end (mod (buffer-modified-p)))
|
177
|
+
(save-excursion
|
178
|
+
(widen)
|
179
|
+
(goto-char (point-min))
|
180
|
+
(while (and (re-search-forward "^=end\\>" nil t)
|
181
|
+
(setq beg (progn (beginning-of-line) (point)))
|
182
|
+
(setq end (re-search-forward "^=begin\\>" nil t)))
|
183
|
+
(goto-char beg)
|
184
|
+
(insert "\r")
|
185
|
+
(while (search-forward "\n" end t)
|
186
|
+
(replace-match "\r" t t))))
|
187
|
+
(set-buffer-modified-p mod))
|
188
|
+
(setq selective-display t
|
189
|
+
selective-display-ellipses rd-selective-display-ellipses))
|
190
|
+
|
191
|
+
(defun rd-show-other-block ()
|
192
|
+
"Shows lines not in RD format before current point."
|
193
|
+
(interactive)
|
194
|
+
(if selective-display
|
195
|
+
(save-excursion
|
196
|
+
(let (end (mod (buffer-modified-p)))
|
197
|
+
(widen)
|
198
|
+
(if (re-search-forward "^\r=end\\>" nil t)
|
199
|
+
(progn
|
200
|
+
(end-of-line)
|
201
|
+
(setq end (point))
|
202
|
+
(beginning-of-line)
|
203
|
+
(delete-char 1)
|
204
|
+
(while (search-forward "\r" end t)
|
205
|
+
(replace-match "\n" t t))))
|
206
|
+
(set-buffer-modified-p mod)))))
|
207
|
+
|
208
|
+
(defun rd-show-other-block-all ()
|
209
|
+
"Shows all lines not in RD format."
|
210
|
+
(interactive)
|
211
|
+
(if selective-display
|
212
|
+
(save-excursion
|
213
|
+
(let (end (mod (buffer-modified-p)))
|
214
|
+
(widen)
|
215
|
+
(goto-char (point-min))
|
216
|
+
(while (re-search-forward "^\r=end\\>" nil t)
|
217
|
+
(end-of-line)
|
218
|
+
(setq end (point))
|
219
|
+
(beginning-of-line)
|
220
|
+
(delete-char 1)
|
221
|
+
(while (search-forward "\r" end t)
|
222
|
+
(replace-match "\n" t t)))
|
223
|
+
(set-buffer-modified-p mod))))
|
224
|
+
(setq selective-display nil selective-display-ellipses t))
|
225
|
+
|
226
|
+
(defun rd-show-label-list ()
|
227
|
+
"Show RD Label list through temporary buffer."
|
228
|
+
(interactive)
|
229
|
+
(occur "^\\(=+\\s-\\|\\+\\|\\s-*:\\|\\s-*---\\)"))
|
230
|
+
|
231
|
+
(defun rd-insert-inline (beg end str)
|
232
|
+
"Insert Inline Inline (general)."
|
233
|
+
(if str
|
234
|
+
(insert (concat beg str end))
|
235
|
+
(progn
|
236
|
+
(if rd-use-prompt-when-insertion-p
|
237
|
+
(rd-insert-inline beg end (read-string (concat beg " elm " end ": ")))
|
238
|
+
(insert beg end)
|
239
|
+
(backward-char (length end))))))
|
240
|
+
|
241
|
+
(defun rd-insert-emphasis (&optional str)
|
242
|
+
"Insert Inline Emphasis."
|
243
|
+
(interactive "*") (rd-insert-inline "((*" "*))" str))
|
244
|
+
|
245
|
+
(defun rd-insert-code (&optional str)
|
246
|
+
"Insert Inline Code."
|
247
|
+
(interactive "*") (rd-insert-inline "(({" "}))" str))
|
248
|
+
|
249
|
+
(defun rd-insert-var (&optional str)
|
250
|
+
"Insert Inline Var."
|
251
|
+
(interactive "*") (rd-insert-inline "((|" "|))" str))
|
252
|
+
|
253
|
+
(defun rd-insert-keyboard (&optional str)
|
254
|
+
"Insert Inline Keyboard."
|
255
|
+
(interactive "*") (rd-insert-inline "((%" "%))" str))
|
256
|
+
|
257
|
+
(defun rd-insert-index (&optional str)
|
258
|
+
"Insert Inline Index."
|
259
|
+
(interactive "*") (rd-insert-inline "((:" ":))" str))
|
260
|
+
|
261
|
+
(defun rd-insert-ref (&optional str)
|
262
|
+
"Insert Inline Reference."
|
263
|
+
(interactive "*") (rd-insert-inline "((<" ">))" str))
|
264
|
+
|
265
|
+
(defun rd-insert-reftourl (&optional str)
|
266
|
+
"Insert Inline RefToURL."
|
267
|
+
(interactive "*") (rd-insert-inline "((<URL:" ">))" str))
|
268
|
+
|
269
|
+
(defun rd-insert-footnote (&optional str)
|
270
|
+
"Insert Inline Footnote."
|
271
|
+
(interactive "*") (rd-insert-inline "((-" "-))" str))
|
272
|
+
|
273
|
+
(defun rd-insert-verb (&optional str)
|
274
|
+
"Insert Inline Verb."
|
275
|
+
(interactive "*") (rd-insert-inline "(('" "'))" str))
|
276
|
+
|
277
|
+
(defun rd-yank-as-url (&optional arg)
|
278
|
+
"Yank as Inline RefToURL."
|
279
|
+
(interactive "*P")
|
280
|
+
(yank arg)
|
281
|
+
(setq this-command 'yank)
|
282
|
+
(let ((yanked-str
|
283
|
+
(concat "((<URL:" (buffer-substring (point) (mark t)) ">))")))
|
284
|
+
(delete-region (point) (mark t))
|
285
|
+
(if (listp arg)
|
286
|
+
(insert yanked-str)
|
287
|
+
(insert-before-markers yanked-str))))
|
288
|
+
|
289
|
+
(defun rd-yank-pop-as-url (arg)
|
290
|
+
"Yank pop as Inline RefToURL."
|
291
|
+
(interactive "*p")
|
292
|
+
(if (not (eq last-command 'yank))
|
293
|
+
(progn
|
294
|
+
(insert (symbol-name last-command))
|
295
|
+
(error "Previous command is not yank-like.")))
|
296
|
+
(setq this-command 'yank)
|
297
|
+
(yank-pop arg)
|
298
|
+
(let ((yanked-str
|
299
|
+
(concat "((<URL:" (buffer-substring (point) (mark t)) ">))")))
|
300
|
+
(delete-region (point) (mark t))
|
301
|
+
(insert yanked-str)))
|
302
|
+
|
303
|
+
(defun rd-newline-and-indent ()
|
304
|
+
"Newline and indent as deep as prev line."
|
305
|
+
(interactive "*")
|
306
|
+
(newline)
|
307
|
+
(rd-indent-line))
|
308
|
+
|
309
|
+
(defun rd-indent-line ()
|
310
|
+
"Indent line as deep as prev line."
|
311
|
+
(interactive "*")
|
312
|
+
(let ((prev-indent (progn
|
313
|
+
(forward-line -1)
|
314
|
+
(rd-current-indentation))))
|
315
|
+
(forward-line 1)
|
316
|
+
(rd-indent-to prev-indent)
|
317
|
+
(back-to-indentation)))
|
318
|
+
|
319
|
+
(defun rd-line-list-p ()
|
320
|
+
"Whether the line is list or not."
|
321
|
+
(save-excursion
|
322
|
+
(beginning-of-line)
|
323
|
+
(looking-at " *\\*\\|---")))
|
324
|
+
|
325
|
+
(defun rd-indent-to (num)
|
326
|
+
(let (beg)
|
327
|
+
(save-excursion
|
328
|
+
(beginning-of-line)
|
329
|
+
(setq beg (point))
|
330
|
+
(back-to-indentation)
|
331
|
+
(delete-region beg (point))
|
332
|
+
(indent-to num))))
|
333
|
+
|
334
|
+
(defun rd-current-indentation ()
|
335
|
+
""
|
336
|
+
(save-excursion
|
337
|
+
(beginning-of-line)
|
338
|
+
(looking-at "--- +\\| *\\(\\* +\\|([0-9]+) +\\)?")
|
339
|
+
(length (buffer-substring (match-beginning 0)(match-end 0)))))
|
340
|
+
|
341
|
+
(defun rd-cite-region (beg end)
|
342
|
+
"Make region into Verbatim."
|
343
|
+
(interactive "r*")
|
344
|
+
(let (listp prev-indent indent)
|
345
|
+
(save-excursion
|
346
|
+
(goto-char beg)
|
347
|
+
(forward-line -1)
|
348
|
+
(setq listp (rd-line-list-p)
|
349
|
+
prev-indent (rd-current-indentation))
|
350
|
+
(forward-line 1)
|
351
|
+
(setq indent (rd-current-indentation))
|
352
|
+
(if (and listp
|
353
|
+
(not (= (- indent prev-indent) 2)))
|
354
|
+
(rd-indent-region beg end (- (+ prev-indent 2) indent))
|
355
|
+
(cond ((= prev-indent indent)
|
356
|
+
(rd-indent-region beg end 2))
|
357
|
+
((> prev-indent indent)
|
358
|
+
(rd-indent-region beg end prev-indent))
|
359
|
+
(t
|
360
|
+
(goto-char end)))))))
|
361
|
+
|
362
|
+
(defun rd-indent-region (beg end &optional indent)
|
363
|
+
"Make the indent of region deeper by INDENT."
|
364
|
+
(interactive "r*")
|
365
|
+
(setq indent (or indent 2))
|
366
|
+
(save-excursion
|
367
|
+
(goto-char beg)
|
368
|
+
(while (< (point) end)
|
369
|
+
(setq end (+ end indent))
|
370
|
+
(insert-char ? indent)
|
371
|
+
(forward-line 1))))
|
372
|
+
|
373
|
+
(defun rd-yank-as-verbatim (&optional arg)
|
374
|
+
(interactive "P")
|
375
|
+
(let ((beg (point))
|
376
|
+
(end (progn
|
377
|
+
(yank)
|
378
|
+
(point)))
|
379
|
+
)
|
380
|
+
(rd-cite-region beg end)
|
381
|
+
(if arg (goto-char beg))))
|
382
|
+
|
383
|
+
(defun rd-insert-buffer-as-verbatim (buf)
|
384
|
+
(interactive "bInsert buffer (verb): ")
|
385
|
+
(insert-buffer buf)
|
386
|
+
(rd-cite-region (point)(mark)))
|
387
|
+
|
388
|
+
|
389
|
+
(defun rd-insert-url (url label)
|
390
|
+
""
|
391
|
+
(interactive "sURL: \nsLabel: ")
|
392
|
+
(if (string= label "")
|
393
|
+
(rd-insert-reftourl url)
|
394
|
+
(rd-insert-ref (concat label "|URL:" url))))
|
395
|
+
|
396
|
+
(defun rd-search-last-listitem ()
|
397
|
+
(beginning-of-line)
|
398
|
+
(if (looking-at "[ \t]*\\(\\*\\|([0-9])\\|:\\|---\\)[ \t]*")
|
399
|
+
(match-string 0)
|
400
|
+
(and (and (eq
|
401
|
+
(rd-current-indentation)
|
402
|
+
(progn (forward-line -1) (rd-current-indentation))
|
403
|
+
)
|
404
|
+
(not (eq (point) (point-min)) )
|
405
|
+
)
|
406
|
+
(rd-search-last-listitem)
|
407
|
+
)
|
408
|
+
)
|
409
|
+
)
|
410
|
+
|
411
|
+
(defun rd-intelligent-newline ()
|
412
|
+
(interactive)
|
413
|
+
(let (item)
|
414
|
+
(setq item
|
415
|
+
(save-excursion (rd-search-last-listitem) )
|
416
|
+
)
|
417
|
+
(end-of-line)
|
418
|
+
(newline)
|
419
|
+
(if item (insert-string item) )
|
420
|
+
)
|
421
|
+
)
|
422
|
+
|
423
|
+
(provide 'rd-mode)
|
424
|
+
;;; rd-mode.el ends here
|
425
|
+
|