Class: Markly::Node

Inherits:
Object
  • Object
show all
Includes:
Enumerable, Inspect
Defined in:
lib/markly/node.rb,
lib/markly/node/inspect.rb,
ext/markly/markly.c

Defined Under Namespace

Modules: Inspect

Constant Summary

Constants included from Inspect

Inspect::PP_INDENT_SIZE

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Inspect

#inspect, #pretty_print

Class Method Details

.new(type) ⇒ Object

Internal: Creates a node based on a node type.

type - A Symbol representing the node to be created. Must be one of the following:

  • ‘:document`

  • ‘:custom`

  • ‘:blockquote`

  • ‘:list`

  • ‘:list_item`

  • ‘:code_block`

  • ‘:html`

  • ‘:paragraph`

  • ‘:header`

  • ‘:hrule`

  • ‘:text`

  • ‘:softbreak`

  • ‘:linebreak`

  • ‘:code`

  • ‘:inline_html`

  • ‘:emph`

  • ‘:strong`

  • ‘:link`

  • ‘:image`



212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
 
# File 'ext/markly/markly.c', line 212

static VALUE rb_node_new(VALUE self, VALUE type) {
	cmark_node_type node_type = 0;
	cmark_node *node;

	Check_Type(type, T_SYMBOL);

	if (type == sym_document)
		node_type = CMARK_NODE_DOCUMENT;
	else if (type == sym_custom_block)
		node_type = CMARK_NODE_CUSTOM_BLOCK;
	else if (type == sym_custom_inline)
		node_type = CMARK_NODE_CUSTOM_INLINE;
	else if (type == sym_blockquote)
		node_type = CMARK_NODE_BLOCK_QUOTE;
	else if (type == sym_list)
		node_type = CMARK_NODE_LIST;
	else if (type == sym_list_item)
		node_type = CMARK_NODE_ITEM;
	else if (type == sym_code_block)
		node_type = CMARK_NODE_CODE_BLOCK;
	else if (type == sym_html)
		node_type = CMARK_NODE_HTML;
	else if (type == sym_paragraph)
		node_type = CMARK_NODE_PARAGRAPH;
	else if (type == sym_header)
		node_type = CMARK_NODE_HEADER;
	else if (type == sym_hrule)
		node_type = CMARK_NODE_HRULE;
	else if (type == sym_text)
		node_type = CMARK_NODE_TEXT;
	else if (type == sym_softbreak)
		node_type = CMARK_NODE_SOFTBREAK;
	else if (type == sym_linebreak)
		node_type = CMARK_NODE_LINEBREAK;
	else if (type == sym_code)
		node_type = CMARK_NODE_CODE;
	else if (type == sym_inline_html)
		node_type = CMARK_NODE_INLINE_HTML;
	else if (type == sym_emph)
		node_type = CMARK_NODE_EMPH;
	else if (type == sym_strong)
		node_type = CMARK_NODE_STRONG;
	else if (type == sym_link)
		node_type = CMARK_NODE_LINK;
	else if (type == sym_image)
		node_type = CMARK_NODE_IMAGE;
	else if (type == sym_footnote_reference)
		node_type = CMARK_NODE_FOOTNOTE_REFERENCE;
	else if (type == sym_footnote_definition)
		node_type = CMARK_NODE_FOOTNOTE_DEFINITION;
	else
		rb_raise(rb_Markly_Error, "invalid node of type %d", node_type);

	node = cmark_node_new(node_type);
	if (node == NULL) {
		rb_raise(rb_Markly_Error, "could not create node of type %d", node_type);
	}

	return rb_Markly_Node_wrap(node);
}

Instance Method Details

#_render_commonmark(*args) ⇒ Object

Internal: Convert the node to a CommonMark string.

Returns a String.



577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
 
# File 'ext/markly/markly.c', line 577

static VALUE rb_render_commonmark(int argc, VALUE *argv, VALUE self) {
	VALUE rb_options, rb_width;
	rb_scan_args(argc, argv, "11", &rb_options, &rb_width);

	int width = 120;
	if (!NIL_P(rb_width)) {
		Check_Type(rb_width, T_FIXNUM);
		width = FIX2INT(rb_width);
	}

	int options;
	cmark_node *node;
	Check_Type(rb_options, T_FIXNUM);

	options = FIX2INT(rb_options);
	TypedData_Get_Struct(self, cmark_node, &rb_Markly_Node_Type, node);

	char *cmark = cmark_render_commonmark(node, options, width);
	VALUE ruby_cmark = rb_str_new2(cmark);
	free(cmark);

	return ruby_cmark;
}

#_render_html(rb_options, rb_extensions) ⇒ Object

Internal: Convert the node to an HTML string.

Returns a String.



531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
 
# File 'ext/markly/markly.c', line 531

static VALUE rb_render_html(VALUE self, VALUE rb_options, VALUE rb_extensions) {
	VALUE rb_ext_name;
	int i;
	cmark_node *node;
	cmark_llist *extensions = NULL;
	cmark_mem *mem = cmark_get_default_mem_allocator();
	Check_Type(rb_options, T_FIXNUM);
	Check_Type(rb_extensions, T_ARRAY);

	int options = FIX2INT(rb_options);
	long extensions_len = RARRAY_LEN(rb_extensions);

	TypedData_Get_Struct(self, cmark_node, &rb_Markly_Node_Type, node);

	for (i = 0; i < extensions_len; ++i) {
		rb_ext_name = RARRAY_PTR(rb_extensions)[i];

		if (!SYMBOL_P(rb_ext_name)) {
			cmark_llist_free(mem, extensions);
			rb_raise(rb_eTypeError, "extension names should be Symbols; got a %"PRIsVALUE"", rb_obj_class(rb_ext_name));
		}

		cmark_syntax_extension *syntax_extension =
			cmark_find_syntax_extension(rb_id2name(SYM2ID(rb_ext_name)));

		if (!syntax_extension) {
			cmark_llist_free(mem, extensions);
			rb_raise(rb_eArgError, "extension %s not found\n", rb_id2name(SYM2ID(rb_ext_name)));
		}

		extensions = cmark_llist_append(mem, extensions, syntax_extension);
	}

	char *html = cmark_render_html(node, options, extensions);
	VALUE ruby_html = rb_str_new2(html);

	cmark_llist_free(mem, extensions);
	free(html);

	return ruby_html;
}

#_render_plaintext(*args) ⇒ Object

Internal: Convert the node to a plain textstring.

Returns a String.



605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
 
# File 'ext/markly/markly.c', line 605

static VALUE rb_render_plaintext(int argc, VALUE *argv, VALUE self) {
	VALUE rb_options, rb_width;
	rb_scan_args(argc, argv, "11", &rb_options, &rb_width);

	int width = 120;
	if (!NIL_P(rb_width)) {
		Check_Type(rb_width, T_FIXNUM);
		width = FIX2INT(rb_width);
	}

	int options;
	cmark_node *node;
	Check_Type(rb_options, T_FIXNUM);

	options = FIX2INT(rb_options);
	TypedData_Get_Struct(self, cmark_node, &rb_Markly_Node_Type, node);

	char *text = cmark_render_plaintext(node, options, width);
	VALUE ruby_text = rb_str_new2(text);
	free(text);

	return ruby_text;
}

#append_after(node) ⇒ Object

Append the given node after the current node.

It’s okay to provide a document node, its children will be appended.



137
138
139
140
141
142
143
144
145
146
147
148
149
 
# File 'lib/markly/node.rb', line 137

def append_after(node)
	if node.type == :document
		node = node.first_child
	end
	
	current = self
	while node
		next_node = node.next
		current.insert_after(node)
		current = node
		node = next_node
	end
end

#append_before(node) ⇒ Object

Append the given node before the current node.

It’s okay to provide a document node, its children will be appended.



156
157
158
159
160
161
162
163
164
165
166
167
 
# File 'lib/markly/node.rb', line 156

def append_before(node)
	if node.type == :document
		node = node.first_child
	end
	
	current = self
	while node
		next_node = node.next
		current.insert_before(node)
		node = next_node
	end
end

#append_child(child) ⇒ Object

Public: Inserts a node as the last child of the current node.

child - A child Markly::Node to insert.

Returns ‘true` if successful. Raises Error if the node can’t be inserted.



677
678
679
680
681
682
683
684
685
686
687
 
# File 'ext/markly/markly.c', line 677

static VALUE rb_node_append_child(VALUE self, VALUE child) {
	cmark_node *node1, *node2;
	TypedData_Get_Struct(self, cmark_node, &rb_Markly_Node_Type, node1);
	TypedData_Get_Struct(child, cmark_node, &rb_Markly_Node_Type, node2);

	if (!cmark_node_append_child(node1, node2)) {
		rb_raise(rb_Markly_Error, "could not append child");
	}

	return Qtrue;
}

#delete ⇒ Object

Internal: Unlinks the node from the tree (fixing pointers in parents and siblings appropriately).



472
473
474
475
476
477
478
479
 
# File 'ext/markly/markly.c', line 472

static VALUE rb_node_unlink(VALUE self) {
	cmark_node *node;
	TypedData_Get_Struct(self, cmark_node, &rb_Markly_Node_Type, node);

	cmark_node_unlink(node);

	return Qnil;
}

#delete_until ⇒ Object

Delete all nodes until the block returns true.



97
98
99
100
101
102
103
104
105
 
# File 'lib/markly/node.rb', line 97

def delete_until
	current = self
	while current
		return current if yield(current)
		next_node = current.next
		current.delete
		current = next_node
	end
end

#dup ⇒ Object

Duplicate the current node and all children.



18
19
20
21
22
23
24
25
26
27
28
 
# File 'lib/markly/node.rb', line 18

def dup
	# This is a bit crazy, but it's the best I can come up with right now:
	node = Markly.parse(self.to_markdown)
	
	# If we aren't duplicating a document, we return `first_child` as the root will be a document node:
	if self.type == :document
		return node
	else
		return node.first_child
	end
end

#each ⇒ Object

Public: Iterate over the children (if any) of the current pointer.



75
76
77
78
79
80
81
82
83
84
 
# File 'lib/markly/node.rb', line 75

def each
	return enum_for(:each) unless block_given?
	
	child = first_child
	while child
		next_child = child.next
		yield child
		child = next_child
	end
end

#extract_children ⇒ Object

Extract the children as a fragment.



172
173
174
175
176
177
178
179
180
 
# File 'lib/markly/node.rb', line 172

def extract_children
	fragment = Markly::Node.new(:custom_inline)
	
	while child = self.first_child
		fragment.append_child(child)
	end
	
	fragment
end

#fence_info ⇒ Object

Public: Gets the fence info of the current node (must be a ‘:code_block`).

Returns a String representing the fence info. Raises a Error if the fence info can’t be retrieved.



995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
 
# File 'ext/markly/markly.c', line 995

static VALUE rb_node_get_fence_info(VALUE self) {
	const char *fence_info;
	cmark_node *node;
	TypedData_Get_Struct(self, cmark_node, &rb_Markly_Node_Type, node);

	fence_info = cmark_node_get_fence_info(node);

	if (fence_info == NULL) {
		rb_raise(rb_Markly_Error, "could not get fence_info");
	}

	return rb_str_new2(fence_info);
}

#fence_info=(info) ⇒ Object

Public: Sets the fence info of the current node (must be a ‘:code_block`).

info - A String representing the new fence info

Raises a Error if the fence info can’t be set.



1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
 
# File 'ext/markly/markly.c', line 1016

static VALUE rb_node_set_fence_info(VALUE self, VALUE info) {
	char *text;
	cmark_node *node;
	Check_Type(info, T_STRING);

	TypedData_Get_Struct(self, cmark_node, &rb_Markly_Node_Type, node);
	text = StringValueCStr(info);

	if (!cmark_node_set_fence_info(node, text)) {
		rb_raise(rb_Markly_Error, "could not set fence_info");
	}

	return Qnil;
}

#find_header(title) ⇒ Object 



86
87
88
89
90
91
92
 
# File 'lib/markly/node.rb', line 86

def find_header(title)
	each do |child|
		if child.type == :header && child.first_child.string_content == title
			return child
		end
	end
end

#first_child ⇒ Object

Public: Fetches the first child of the node.

Returns a Markly::Node if a child exists, ‘nil` otherise.



485
486
487
488
489
490
491
492
 
# File 'ext/markly/markly.c', line 485

static VALUE rb_node_first_child(VALUE self) {
	cmark_node *node, *child;
	TypedData_Get_Struct(self, cmark_node, &rb_Markly_Node_Type, node);

	child = cmark_node_first_child(node);

	return rb_Markly_Node_wrap(child);
}

#header_level ⇒ Object

Public: Gets the header level of the current node (must be a ‘:header`).

Returns a Number representing the header level. Raises a Error if the header level can’t be retrieved.



816
817
818
819
820
821
822
823
824
825
826
827
828
 
# File 'ext/markly/markly.c', line 816

static VALUE rb_node_get_header_level(VALUE self) {
	int header_level;
	cmark_node *node;
	TypedData_Get_Struct(self, cmark_node, &rb_Markly_Node_Type, node);

	header_level = cmark_node_get_header_level(node);

	if (header_level == 0) {
		rb_raise(rb_Markly_Error, "could not get header_level");
	}

	return INT2NUM(header_level);
}

#header_level=(level) ⇒ Object

Public: Sets the header level of the current node (must be a ‘:header`).

level - A Number representing the new header level

Raises a Error if the header level can’t be set.



837
838
839
840
841
842
843
844
845
846
847
848
849
850
 
# File 'ext/markly/markly.c', line 837

static VALUE rb_node_set_header_level(VALUE self, VALUE level) {
	int l;
	cmark_node *node;
	Check_Type(level, T_FIXNUM);

	TypedData_Get_Struct(self, cmark_node, &rb_Markly_Node_Type, node);
	l = FIX2INT(level);

	if (!cmark_node_set_header_level(node, l)) {
		rb_raise(rb_Markly_Error, "could not set header_level");
	}

	return Qnil;
}

#html_escape_href(rb_text) ⇒ Object

Internal: Escapes href URLs safely.



1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
 
# File 'ext/markly/markly.c', line 1109

static VALUE rb_html_escape_href(VALUE self, VALUE rb_text) {
	char *result;
	cmark_node *node;
	Check_Type(rb_text, T_STRING);

	TypedData_Get_Struct(self, cmark_node, &rb_Markly_Node_Type, node);

	cmark_mem *mem = cmark_node_mem(node);
	cmark_strbuf buf = CMARK_BUF_INIT(mem);

	if (houdini_escape_href(&buf, (const uint8_t *)RSTRING_PTR(rb_text),
													(bufsize_t)RSTRING_LEN(rb_text))) {
		result = (char *)cmark_strbuf_detach(&buf);
		return rb_str_new2(result);
	}

	return rb_text;
}

#html_escape_html(rb_text) ⇒ Object

Internal: Escapes HTML content safely.



1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
 
# File 'ext/markly/markly.c', line 1129

static VALUE rb_html_escape_html(VALUE self, VALUE rb_text) {
	char *result;
	cmark_node *node;
	Check_Type(rb_text, T_STRING);

	TypedData_Get_Struct(self, cmark_node, &rb_Markly_Node_Type, node);

	cmark_mem *mem = cmark_node_mem(node);
	cmark_strbuf buf = CMARK_BUF_INIT(mem);

	if (houdini_escape_html0(&buf, (const uint8_t *)RSTRING_PTR(rb_text),
													 (bufsize_t)RSTRING_LEN(rb_text), 0)) {
		result = (char *)cmark_strbuf_detach(&buf);
		return rb_str_new2(result);
	}

	return rb_text;
}

#insert_after(sibling) ⇒ Object

Public: Inserts a node as a sibling after the current node.

sibling - A sibling Markly::Node to insert.

Returns ‘true` if successful. Raises Error if the node can’t be inserted.



637
638
639
640
641
642
643
644
645
646
647
 
# File 'ext/markly/markly.c', line 637

static VALUE rb_node_insert_after(VALUE self, VALUE sibling) {
	cmark_node *node1, *node2;
	TypedData_Get_Struct(self, cmark_node, &rb_Markly_Node_Type, node1);
	TypedData_Get_Struct(sibling, cmark_node, &rb_Markly_Node_Type, node2);

	if (!cmark_node_insert_after(node1, node2)) {
		rb_raise(rb_Markly_Error, "could not insert after");
	}

	return Qtrue;
}

#insert_before(sibling) ⇒ Object

Public: Inserts a node as a sibling before the current node.

sibling - A sibling Markly::Node to insert.

Returns ‘true` if successful. Raises Error if the node can’t be inserted.



515
516
517
518
519
520
521
522
523
524
525
 
# File 'ext/markly/markly.c', line 515

static VALUE rb_node_insert_before(VALUE self, VALUE sibling) {
	cmark_node *node1, *node2;
	TypedData_Get_Struct(self, cmark_node, &rb_Markly_Node_Type, node1);
	TypedData_Get_Struct(sibling, cmark_node, &rb_Markly_Node_Type, node2);

	if (!cmark_node_insert_before(node1, node2)) {
		rb_raise(rb_Markly_Error, "could not insert before");
	}

	return Qtrue;
}

#last_child ⇒ Object

Public: Fetches the first child of the current node.

Returns a Markly::Node if a child exists, ‘nil` otherise.



693
694
695
696
697
698
699
700
 
# File 'ext/markly/markly.c', line 693

static VALUE rb_node_last_child(VALUE self) {
	cmark_node *node, *child;
	TypedData_Get_Struct(self, cmark_node, &rb_Markly_Node_Type, node);

	child = cmark_node_last_child(node);

	return rb_Markly_Node_wrap(child);
}

#list_start ⇒ Object

Public: Gets the starting number the current node (must be an ‘:ordered_list`).

Returns a Number representing the starting number. Raises a Error if the starting number can’t be retrieved.



913
914
915
916
917
918
919
920
921
922
923
924
 
# File 'ext/markly/markly.c', line 913

static VALUE rb_node_get_list_start(VALUE self) {
	cmark_node *node;
	TypedData_Get_Struct(self, cmark_node, &rb_Markly_Node_Type, node);

	if (cmark_node_get_type(node) != CMARK_NODE_LIST ||
			cmark_node_get_list_type(node) != CMARK_ORDERED_LIST) {
		rb_raise(rb_Markly_Error, "can't get list_start for non-ordered list %d",
						 cmark_node_get_list_type(node));
	}

	return INT2NUM(cmark_node_get_list_start(node));
}

#list_start=(start) ⇒ Object

Public: Sets the starting number of the current node (must be an ‘:ordered_list`).

level - A Number representing the new starting number

Raises a Error if the starting number can’t be set.



934
935
936
937
938
939
940
941
942
943
944
945
946
947
 
# File 'ext/markly/markly.c', line 934

static VALUE rb_node_set_list_start(VALUE self, VALUE start) {
	int s;
	cmark_node *node;
	Check_Type(start, T_FIXNUM);

	TypedData_Get_Struct(self, cmark_node, &rb_Markly_Node_Type, node);
	s = FIX2INT(start);

	if (!cmark_node_set_list_start(node, s)) {
		rb_raise(rb_Markly_Error, "could not set list_start");
	}

	return Qnil;
}

#list_tight ⇒ Object

Public: Gets the tight status the current node (must be a ‘:list`).

Returns a ‘true` if the list is tight, `false` otherwise. Raises a Error if the starting number can’t be retrieved.



955
956
957
958
959
960
961
962
963
964
965
966
967
 
# File 'ext/markly/markly.c', line 955

static VALUE rb_node_get_list_tight(VALUE self) {
	int flag;
	cmark_node *node;
	TypedData_Get_Struct(self, cmark_node, &rb_Markly_Node_Type, node);

	if (cmark_node_get_type(node) != CMARK_NODE_LIST) {
		rb_raise(rb_Markly_Error, "can't get list_tight for non-list");
	}

	flag = cmark_node_get_list_tight(node);

	return flag ? Qtrue : Qfalse;
}

#list_tight=(tight) ⇒ Object

Public: Sets the tight status of the current node (must be a ‘:list`).

tight - A Boolean representing the new tightness

Raises a Error if the tightness can’t be set.



976
977
978
979
980
981
982
983
984
985
986
987
 
# File 'ext/markly/markly.c', line 976

static VALUE rb_node_set_list_tight(VALUE self, VALUE tight) {
	int t;
	cmark_node *node;
	TypedData_Get_Struct(self, cmark_node, &rb_Markly_Node_Type, node);
	t = RTEST(tight);

	if (!cmark_node_set_list_tight(node, t)) {
		rb_raise(rb_Markly_Error, "could not set list_tight");
	}

	return Qnil;
}

#list_type ⇒ Object

Public: Gets the list type of the current node (must be a ‘:list`).

Returns a Symbol. Raises a Error if the title can’t be retrieved.



858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
 
# File 'ext/markly/markly.c', line 858

static VALUE rb_node_get_list_type(VALUE self) {
	int list_type;
	cmark_node *node;
	VALUE symbol;
	TypedData_Get_Struct(self, cmark_node, &rb_Markly_Node_Type, node);

	list_type = cmark_node_get_list_type(node);

	if (list_type == CMARK_BULLET_LIST) {
		symbol = sym_bullet_list;
	} else if (list_type == CMARK_ORDERED_LIST) {
		symbol = sym_ordered_list;
	} else {
		rb_raise(rb_Markly_Error, "could not get list_type");
	}

	return symbol;
}

#list_type=(list_type) ⇒ Object

Public: Sets the list type of the current node (must be a ‘:list`).

level - A Symbol representing the new list type

Raises a Error if the list type can’t be set.



884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
 
# File 'ext/markly/markly.c', line 884

static VALUE rb_node_set_list_type(VALUE self, VALUE list_type) {
	int type = 0;
	cmark_node *node;
	Check_Type(list_type, T_SYMBOL);

	TypedData_Get_Struct(self, cmark_node, &rb_Markly_Node_Type, node);

	if (list_type == sym_bullet_list) {
		type = CMARK_BULLET_LIST;
	} else if (list_type == sym_ordered_list) {
		type = CMARK_ORDERED_LIST;
	} else {
		rb_raise(rb_Markly_Error, "invalid list_type");
	}

	if (!cmark_node_set_list_type(node, type)) {
		rb_raise(rb_Markly_Error, "could not set list_type");
	}

	return Qnil;
}

#next ⇒ Object

Public: Fetches the next sibling of the node.

Returns a Markly::Node if a sibling exists, ‘nil` otherwise.



498
499
500
501
502
503
504
505
 
# File 'ext/markly/markly.c', line 498

static VALUE rb_node_next(VALUE self) {
	cmark_node *node, *next;
	TypedData_Get_Struct(self, cmark_node, &rb_Markly_Node_Type, node);

	next = cmark_node_next(node);

	return rb_Markly_Node_wrap(next);
}

#next_heading ⇒ Object 



122
123
124
125
126
127
128
129
130
 
# File 'lib/markly/node.rb', line 122

def next_heading
	current = self.next
	while current
		if current.type == :heading
			return current
		end
		current = current.next
	end
end

#parent ⇒ Object

Public: Fetches the parent of the current node.

Returns a Markly::Node if a parent exists, ‘nil` otherise.



706
707
708
709
710
711
712
713
 
# File 'ext/markly/markly.c', line 706

static VALUE rb_node_parent(VALUE self) {
	cmark_node *node, *parent;
	TypedData_Get_Struct(self, cmark_node, &rb_Markly_Node_Type, node);

	parent = cmark_node_parent(node);

	return rb_Markly_Node_wrap(parent);
}

#parent_footnote_def ⇒ Object 



1070
1071
1072
1073
1074
1075
1076
1077
1078
 
# File 'ext/markly/markly.c', line 1070

static VALUE rb_node_get_parent_footnote_def(VALUE self) {
	cmark_node *node;
	cmark_node *parent;
	TypedData_Get_Struct(self, cmark_node, &rb_Markly_Node_Type, node);

	parent = cmark_node_parent_footnote_def(node);

	return rb_Markly_Node_wrap(parent);
}

#prepend_child(child) ⇒ Object

Public: Inserts a node as the first child of the current node.

child - A child Markly::Node to insert.

Returns ‘true` if successful. Raises Error if the node can’t be inserted.



657
658
659
660
661
662
663
664
665
666
667
 
# File 'ext/markly/markly.c', line 657

static VALUE rb_node_prepend_child(VALUE self, VALUE child) {
	cmark_node *node1, *node2;
	TypedData_Get_Struct(self, cmark_node, &rb_Markly_Node_Type, node1);
	TypedData_Get_Struct(child, cmark_node, &rb_Markly_Node_Type, node2);

	if (!cmark_node_prepend_child(node1, node2)) {
		rb_raise(rb_Markly_Error, "could not prepend child");
	}

	return Qtrue;
}

#previous ⇒ Object

Public: Fetches the previous sibling of the current node.

Returns a Markly::Node if a parent exists, ‘nil` otherise.



719
720
721
722
723
724
725
726
 
# File 'ext/markly/markly.c', line 719

static VALUE rb_node_previous(VALUE self) {
	cmark_node *node, *previous;
	TypedData_Get_Struct(self, cmark_node, &rb_Markly_Node_Type, node);

	previous = cmark_node_previous(node);

	return rb_Markly_Node_wrap(previous);
}

#replace(other) ⇒ Object 



273
274
275
276
277
278
279
280
281
282
283
284
285
286
 
# File 'ext/markly/markly.c', line 273

static VALUE rb_node_replace(VALUE self, VALUE other) {
	cmark_node *current_node = NULL, *replacement_node = NULL;
	
	TypedData_Get_Struct(self, cmark_node, &rb_Markly_Node_Type, current_node);
	TypedData_Get_Struct(other, cmark_node, &rb_Markly_Node_Type, replacement_node);
	
	int result = cmark_node_replace(current_node, replacement_node);
	
	if (result == 0) {
		rb_raise(rb_Markly_Error, "could not replace node");
	}
	
	return other;
}

#replace_section(new_node, replace_header: true, remove_subsections: true) ⇒ Object

Replace a section (header + content) with a new node.



112
113
114
115
116
117
118
119
120
 
# File 'lib/markly/node.rb', line 112

def replace_section(new_node, replace_header: true, remove_subsections: true)
	# Delete until the next heading:
	self.next&.delete_until do |node|
		node.type == :header && (!remove_subsections || node.header_level <= self.header_level)
	end
	
	self.append_after(new_node) if new_node
	self.delete if replace_header
end

#source_position ⇒ Object

Public: Fetches the source_position of the node.

Returns a Hash containing Symbol keys of the positions.



435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
 
# File 'ext/markly/markly.c', line 435

static VALUE rb_node_get_source_position(VALUE self) {
	int start_line, start_column, end_line, end_column;
	VALUE result;

	cmark_node *node;
	TypedData_Get_Struct(self, cmark_node, &rb_Markly_Node_Type, node);

	start_line = cmark_node_get_start_line(node);
	start_column = cmark_node_get_start_column(node);
	end_line = cmark_node_get_end_line(node);
	end_column = cmark_node_get_end_column(node);

	result = rb_hash_new();
	rb_hash_aset(result, CSTR2SYM("start_line"), INT2NUM(start_line));
	rb_hash_aset(result, CSTR2SYM("start_column"), INT2NUM(start_column));
	rb_hash_aset(result, CSTR2SYM("end_line"), INT2NUM(end_line));
	rb_hash_aset(result, CSTR2SYM("end_column"), INT2NUM(end_column));

	return result;
}

#string_content ⇒ Object

Public: Fetch the string contents of the node.

Returns a String or nil if there is no string content.



300
301
302
303
304
305
306
307
308
309
310
311
312
 
# File 'ext/markly/markly.c', line 300

static VALUE rb_node_get_string_content(VALUE self) {
	const char *text;
	cmark_node *node;
	TypedData_Get_Struct(self, cmark_node, &rb_Markly_Node_Type, node);

	text = cmark_node_get_literal(node);

	if (text == NULL) {
		return RUBY_Qnil;
	}

	return encode_utf8_string(text);
}

#string_content=(s) ⇒ Object

Public: Sets the string content of the node.

string - A String containing new content.

Raises Error if the string content can’t be set.



321
322
323
324
325
326
327
328
329
330
331
332
333
334
 
# File 'ext/markly/markly.c', line 321

static VALUE rb_node_set_string_content(VALUE self, VALUE s) {
	char *text;
	cmark_node *node;
	Check_Type(s, T_STRING);

	TypedData_Get_Struct(self, cmark_node, &rb_Markly_Node_Type, node);
	text = StringValueCStr(s);

	if (!cmark_node_set_literal(node, text)) {
		rb_raise(rb_Markly_Error, "could not set string content");
	}

	return Qnil;
}

#table_alignments ⇒ Object 



1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
 
# File 'ext/markly/markly.c', line 1080

static VALUE rb_node_get_table_alignments(VALUE self) {
	uint16_t column_count, i;
	uint8_t *alignments;
	cmark_node *node;
	VALUE ary;
	TypedData_Get_Struct(self, cmark_node, &rb_Markly_Node_Type, node);

	column_count = cmark_gfm_extensions_get_table_columns(node);
	alignments = cmark_gfm_extensions_get_table_alignments(node);

	if (!column_count || !alignments) {
		rb_raise(rb_Markly_Error, "could not get column_count or alignments");
	}

	ary = rb_ary_new();
	for (i = 0; i < column_count; ++i) {
		if (alignments[i] == 'l')
			rb_ary_push(ary, sym_left);
		else if (alignments[i] == 'c')
			rb_ary_push(ary, sym_center);
		else if (alignments[i] == 'r')
			rb_ary_push(ary, sym_right);
		else
			rb_ary_push(ary, Qnil);
	}
	return ary;
}

#tasklist_item_checked=(item_checked) ⇒ Object

Public: Sets the checkbox state of the current node (must be a ‘:tasklist`).

item_checked - A Boolean representing the new checkbox state

Returns a Boolean representing the new checkbox state. Raises a Error if the checkbox state can’t be set.



1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
 
# File 'ext/markly/markly.c', line 1053

static VALUE rb_node_set_tasklist_item_checked(VALUE self, VALUE item_checked) {
	int tasklist_state;
	cmark_node *node;
	TypedData_Get_Struct(self, cmark_node, &rb_Markly_Node_Type, node);
	tasklist_state = RTEST(item_checked);

	if (!cmark_gfm_extensions_set_tasklist_item_checked(node, tasklist_state)) {
		rb_raise(rb_Markly_Error, "could not set tasklist_item_checked");
	};

	if (tasklist_state) {
		return Qtrue;
	} else {
		return Qfalse;
	}
}

#tasklist_item_checked? ⇒ Boolean

Returns:

  • (Boolean) 


1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
 
# File 'ext/markly/markly.c', line 1031

static VALUE rb_node_get_tasklist_item_checked(VALUE self) {
	int tasklist_state;
	cmark_node *node;
	TypedData_Get_Struct(self, cmark_node, &rb_Markly_Node_Type, node);

	tasklist_state = cmark_gfm_extensions_get_tasklist_item_checked(node);

	if (tasklist_state == 1) {
		return Qtrue;
	} else {
		return Qfalse;
	}
}

#title ⇒ Object

Public: Gets the title of the current node (must be a ‘:link` or `:image`).

Returns a String. Raises a Error if the title can’t be retrieved.



775
776
777
778
779
780
781
782
783
784
785
786
 
# File 'ext/markly/markly.c', line 775

static VALUE rb_node_get_title(VALUE self) {
	const char *text;
	cmark_node *node;
	TypedData_Get_Struct(self, cmark_node, &rb_Markly_Node_Type, node);

	text = cmark_node_get_title(node);
	if (text == NULL) {
		rb_raise(rb_Markly_Error, "could not get title");
	}

	return rb_str_new2(text);
}

#title=(title) ⇒ Object

Public: Sets the title of the current node (must be a ‘:link` or `:image`).

title - A String representing the new title

Raises a Error if the title can’t be set.



795
796
797
798
799
800
801
802
803
804
805
806
807
808
 
# File 'ext/markly/markly.c', line 795

static VALUE rb_node_set_title(VALUE self, VALUE title) {
	char *text;
	cmark_node *node;
	Check_Type(title, T_STRING);

	TypedData_Get_Struct(self, cmark_node, &rb_Markly_Node_Type, node);
	text = StringValueCStr(title);

	if (!cmark_node_set_title(node, text)) {
		rb_raise(rb_Markly_Error, "could not set title");
	}

	return Qnil;
}

#to_commonmark(flags: DEFAULT, width: 0) ⇒ Object Also known as: to_markdown

Public: Convert the node to a CommonMark string.

flags - A Symbol or of Symbols indicating the render options width - Column to wrap the output at

Returns a String.



58
59
60
 
# File 'lib/markly/node.rb', line 58

def to_commonmark(flags: DEFAULT, width: 0)
	_render_commonmark(flags, width).force_encoding("utf-8")
end

#to_html(flags: DEFAULT, extensions: []) ⇒ Object

Public: Convert the node to an HTML string.

flags - A Symbol or of Symbols indicating the render options extensions - An of Symbols indicating the extensions to use

Returns a String.



48
49
50
 
# File 'lib/markly/node.rb', line 48

def to_html(flags: DEFAULT, extensions: [])
	_render_html(flags, extensions).force_encoding("utf-8")
end

#to_plaintext(flags: DEFAULT, width: 0) ⇒ Object

Public: Convert the node to a plain text string.

flags - A Symbol or of Symbols indicating the render options width - Column to wrap the output at

Returns a String.



70
71
72
 
# File 'lib/markly/node.rb', line 70

def to_plaintext(flags: DEFAULT, width: 0)
	_render_plaintext(flags, width).force_encoding("utf-8")
end

#type ⇒ Object

Public: Fetches the list type of the node.

Returns a Symbol representing the node’s type.



341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
 
# File 'ext/markly/markly.c', line 341

static VALUE rb_node_get_type(VALUE self) {
	int node_type = 0;
	cmark_node *node = NULL;
	VALUE symbol = Qnil;
	const char *s = NULL;

	TypedData_Get_Struct(self, cmark_node, &rb_Markly_Node_Type, node);

	node_type = cmark_node_get_type(node);
	symbol = Qnil;

	switch (node_type) {
	case CMARK_NODE_DOCUMENT:
		symbol = sym_document;
		break;
	case CMARK_NODE_CUSTOM_BLOCK:
		symbol = sym_custom_block;
		break;
	case CMARK_NODE_CUSTOM_INLINE:
		symbol = sym_custom_inline;
		break;
	case CMARK_NODE_BLOCK_QUOTE:
		symbol = sym_blockquote;
		break;
	case CMARK_NODE_LIST:
		symbol = sym_list;
		break;
	case CMARK_NODE_ITEM:
		symbol = sym_list_item;
		break;
	case CMARK_NODE_CODE_BLOCK:
		symbol = sym_code_block;
		break;
	case CMARK_NODE_HTML:
		symbol = sym_html;
		break;
	case CMARK_NODE_PARAGRAPH:
		symbol = sym_paragraph;
		break;
	case CMARK_NODE_HEADER:
		symbol = sym_header;
		break;
	case CMARK_NODE_HRULE:
		symbol = sym_hrule;
		break;
	case CMARK_NODE_TEXT:
		symbol = sym_text;
		break;
	case CMARK_NODE_SOFTBREAK:
		symbol = sym_softbreak;
		break;
	case CMARK_NODE_LINEBREAK:
		symbol = sym_linebreak;
		break;
	case CMARK_NODE_CODE:
		symbol = sym_code;
		break;
	case CMARK_NODE_INLINE_HTML:
		symbol = sym_inline_html;
		break;
	case CMARK_NODE_EMPH:
		symbol = sym_emph;
		break;
	case CMARK_NODE_STRONG:
		symbol = sym_strong;
		break;
	case CMARK_NODE_LINK:
		symbol = sym_link;
		break;
	case CMARK_NODE_IMAGE:
		symbol = sym_image;
		break;
	case CMARK_NODE_FOOTNOTE_REFERENCE:
		symbol = sym_footnote_reference;
		break;
	case CMARK_NODE_FOOTNOTE_DEFINITION:
		symbol = sym_footnote_definition;
		break;
	default:
		if (node->extension) {
			s = node->extension->get_type_string_func(node->extension, node);
			return ID2SYM(rb_intern(s));
		}
		rb_raise(rb_Markly_Error, "invalid node type %d", node_type);
	}

	return symbol;
}

#type_string ⇒ Object

Public: Returns the type of the current pointer as a string.

Returns a String.



461
462
463
464
465
466
 
# File 'ext/markly/markly.c', line 461

static VALUE rb_node_get_type_string(VALUE self) {
	cmark_node *node;
	TypedData_Get_Struct(self, cmark_node, &rb_Markly_Node_Type, node);

	return rb_str_new2(cmark_node_get_type_string(node));
}

#url ⇒ Object

Public: Gets the URL of the current node (must be a ‘:link` or `:image`).

Returns a String. Raises a Error if the URL can’t be retrieved.



734
735
736
737
738
739
740
741
742
743
744
745
 
# File 'ext/markly/markly.c', line 734

static VALUE rb_node_get_url(VALUE self) {
	const char *text;
	cmark_node *node;
	TypedData_Get_Struct(self, cmark_node, &rb_Markly_Node_Type, node);

	text = cmark_node_get_url(node);
	if (text == NULL) {
		rb_raise(rb_Markly_Error, "could not get url");
	}

	return rb_str_new2(text);
}

#url=(url) ⇒ Object

Public: Sets the URL of the current node (must be a ‘:link` or `:image`).

url - A String representing the new URL

Raises a Error if the URL can’t be set.



754
755
756
757
758
759
760
761
762
763
764
765
766
767
 
# File 'ext/markly/markly.c', line 754

static VALUE rb_node_set_url(VALUE self, VALUE url) {
	cmark_node *node;
	char *text;
	Check_Type(url, T_STRING);

	TypedData_Get_Struct(self, cmark_node, &rb_Markly_Node_Type, node);
	text = StringValueCStr(url);

	if (!cmark_node_set_url(node, text)) {
		rb_raise(rb_Markly_Error, "could not set url");
	}

	return Qnil;
}

#walk {|_self| ... } ⇒ Object

Public: An iterator that “walks the tree,” descending into children recursively.

block - A Proc representing the action to take for each child

Yields:

  • (_self)

Yield Parameters:

  • _self (Markly::Node) —

    the object that the method was called on



33
34
35
36
37
38
39
40
 
# File 'lib/markly/node.rb', line 33

def walk(&block)
	return enum_for(:walk) unless block_given?
	
	yield self
	each do |child|
		child.walk(&block)
	end
end