1
2
3
4
5
6
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
33
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
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
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
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
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
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
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
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
|
\documentclass{ltxdoc}
% \usepackage{tgschola,url}
\usepackage{url}
\usepackage[english]{babel}
\usepackage{hyperref}
\usepackage{luacode}
\usepackage{framed}
% Version is defined in the makefile, use default values when compiled directly
\ifdefined\version\else
\def\version{v0.1r}
\let\gitdate\date
\fi
\newcommand\modulename[1]{\subsection{#1}\label{sec:#1}}
\newcommand\modulesummary[1]{#1\\}
\newcommand\moduleclass[1]{\subsubsection{Class: #1}}
\newcommand\functionname[2]{\par\noindent\textbf{#1(#2)}\\}
\newcommand\functionsummary[1]{#1\\\textbf{Parameters:}\\}
\newcommand\functionparam[2]{\texttt{#1}: #2\\}
\newcommand\functionreturn[1]{\textbf{Return: }\\#1\\}
\begin{document}
\title{The \textsc{LuaXML} library}
\author{Paul Chakravarti \and Michal Hoftich}
\date{Version \version\\\gitdate}
\maketitle
\tableofcontents
\section{Introduction}
|LuaXML| is pure lua library for processing and serializing of the |xml| files.
The base code code has been written by Paul Chakravarti, with minor changes
which brings Lua 5.3 or HTML 5 support. On top of that, new modules for
accessing the |xml| files using |DOM| like methods or |CSS|
selectors\footnote{Thanks to Leaf Corcoran for |CSS selector| parsing code.}
have been added.
The documentation is divided to three parts -- first part deals with the |DOM|
library, second part describes the low-level libraries and the third part is
original documentation by Paul Chakravarti.
% Current release is aimed mainly as support for the odsfile package.
% In first release it was included with the odsfile package,
% but as it is general library which can be used also with other packages,
% I decided to distribute it as separate library.
\section{The \texttt{DOM\_Object} library}
This library can process a |xml| sources using |DOM| like functions. To load
it, you need to require |luaxml-domobject.lua| file. The |parse| function
provided by the library creates \texttt{DOM\_Object} object, which provides several
methods for processing the |xml| tree.
\begin{verbatim}
local dom = require "luaxml-domobject"
local document = [[
<html>
<head><title>sample</title></head>
<body>
<h1>test</h1>
<p>hello</p>
</body>
</html>
]]
-- dom.parse returns the DOM_Object
local obj = dom.parse(document)
-- it is possible to call methods on the object
local root_node = obj:root_node()
for _, x in ipairs(root_node:get_children()) do
print(x:get_element_name())
end
\end{verbatim}
The details about available methods can be found in the API docs, section
\ref{sec:luaxml-domobject}. The above code will load a |xml| document, it will
get the ROOT element and print all it's children element names. The
\verb|DOM_Object:get_children| function returns Lua table, so it is possible to
loop over it using standard table functions.
\begin{framed}
\begin{luacode*}
dom = require "luaxml-domobject"
local document = [[
<html>
<head><title>sample</title></head>
<body>
<h1>test</h1>
<p>hello</p>
</body>
</html>
]]
-- dom.parse returns the DOM_Object
obj = dom.parse(document)
-- it is possible to call methods on the object
local root_node = obj:root_node()
for _, x in ipairs(root_node:get_children()) do
tex.print(x:get_element_name().. "\\par")
end
\end{luacode*}
\end{framed}
\subsection{Void elements}
The \verb|DOM_Object.parse| function tries to support the HTML void elements,
such as \verb|<img>| or \verb|<hr>|. They cannot have closing tags, a parse
error occurs when the closing tags are used.
It is possible to define a different set of void elements using the second parameter
for \verb|DOM_Object.parse|:
\begin{verbatim}
obj = dom.parse(document, {custom_void = true})
\end{verbatim}
An empty table will disable all void elements. This setting is recommended for common |xml| documents.
\subsection{Node selection methods}
There are some other methods for element retrieving.
\subsubsection{The \texttt{DOM\_Object:get\_path} method}
If you want to print text content of all child elements of the body element, you can use \verb|DOM_Object:get_path|:
\begin{verbatim}
local path = obj:get_path("html body")
for _, el in ipairs(path[1]:get_children()) do
print(el:get_text())
end
\end{verbatim}
The \verb|DOM_Object:get_path| function always return array with all elements
which match the requested path, even it there is only one such element. In this
case, it is possible to use standard Lua table indexing to get the first and
only one matched element and get it's children using
\verb|DOM_Object:get_children| method. It the children node is an element, it's
text content is printed using \verb|DOM_Object:get_text|.
\begin{framed}
\begin{luacode*}
local path = obj:get_path("html body")
for _, el in ipairs(path[1]:get_children()) do
if el:is_element() then
tex.print(el:get_text().."\\par")
end
end
\end{luacode*}
\end{framed}
\subsubsection{The \texttt{DOM\_Object:query\_selector} method}
This method uses |CSS selector| syntax to select elements, similarly to JavaScript \textit{jQuery} library.
\begin{verbatim}
for _, el in ipairs(obj:query_selector("h1,p")) do
print(el:get_text())
end
\end{verbatim}
\begin{framed}
\begin{luacode*}
for _, el in ipairs(obj:query_selector("h1,p")) do
tex.print(el:get_text().."\\par")
end
\end{luacode*}
\end{framed}
It supports also |XML| namespaces, using \verb_namespace|element_ syntax.
\subsubsection{Supported CSS selectors}\label{sec:css_selectors}
The \verb|query_selector| method supports following CSS selectors:
\begin{description}
\item[Universal selector -- \texttt{*}] -- select any element.
\item[Type selector -- \texttt{elementname}] -- Selects all elements that have the given node name.
\item[Class selector -- \texttt{.classname}] -- Selects all elements that have the given class attribute.
\item[ID selector -- \texttt{\#idname}] -- Selects an element based on the value of its id attribute.
\item[Attribute selector -- \texttt{[attrname='value']}] -- Selects all elements that have the given attribute.
It can have the following variants:
\texttt{[attrname]} -- elements that contain given attribute,
\texttt{[attr\string|=value]} -- attribute text is exactly the value, with optional hyphen at the end,
\verb|[attr~=value]| -- attribute name of attr whose value is a whitespace-separated list of words, one of which is exactly value,
\verb|[attr^=value]| -- attribute text starts with value,
\texttt{[attr\$=value]} -- attribute text ends with value.
\item[Grouping selector -- \texttt{,}] -- This is a grouping method, it selects all the matching nodes.
\end{description}
\bigskip
\noindent It is also possible to combine selectors using \textit{combinators} to make more specific searches. Supported combinators:
\begin{description}
\item[Descendant combinator -- \texttt{A B}] -- match all B elements that are inside A elements.
\item[Child combinator -- \verb|A > B|] -- match B elements that are nested directly inside a A element.
\item[General sibling combinator -- \texttt{A \char`\~ ~B}] -- the second element
follows the first (though not necessarily immediately), and both share the
same parent.
\item[Adjacent sibling combinator -- \texttt{A + B}] -- the second element directly follows the first, and both share the same parent.
\end{description}
\bigskip
\noindent LuaXML also supports some CSS pseudo-classes. A pseudo-class is a
keyword added to a selector that specifies a special state of the selected
element. The following are supported:
\begin{description}
\item[:first-child] -- matches an element that is the first of its siblings.
\item[:first-of-type] -- matches an element that is the first of its siblings,
and also matches a certain type selector.
\item[:last-child] -- matches an element that is the last of its siblings.
\item[:last-of-type] -- matches an element that is the last of its siblings,
and also matches a certain type selector.
\item[:nth-child] -- matches elements based on their position in a group of siblings.
It can be used like this: \verb|li:nth-child(2)|.
\end{description}
\subsection{Element traversing}
\subsubsection{The \texttt{DOM\_Object:traverse\_elements} method}
It may be useful to traverse over all elements and apply a function on all of them.
\begin{verbatim}
obj:traverse_elements(function(node)
print(node:get_text())
end)
\end{verbatim}
\begin{framed}
\begin{luacode*}
obj:traverse_elements(function(node)
tex.print(node:get_text().."\\par")
end)
\end{luacode*}
\end{framed}
The \verb|get_text| method gets text from all children elements, so the first
line shows all text contained in the \verb|<html>| element, the second one in
\verb|<head>| element and so on.
\subsection{DOM modifications}
It is possible to add new elements, text nodes, or to remove them.
\begin{verbatim}
local headers = obj:query_selector("h1")
for _, header in ipairs(headers) do
header:remove_node()
end
-- query selector returns array, we must retrieve the first element
-- to get the actual body element
local body = obj:query_selector("body")[1]
local paragraph = body:create_element("p", {})
body:add_child_node(paragraph)
paragraph:add_child_node(paragraph:create_text_node("This is a second paragraph"))
for _, el in ipairs(body:get_children()) do
if el:is_element() then
print(el:get_element_name().. ": ".. el:get_text())
end
end
\end{verbatim}
In this example, \verb|<h1>| element is being removed from the sample document, and new
paragraph is added. Two paragraphs should be shown in the output:
\begin{framed}
\begin{luacode*}
local headers = obj:query_selector("h1")
-- query selector returns array, we must retrieve the first element
-- to get the actual body element
local body = obj:query_selector("body")[1]
local oldbody = body:copy_node()
for _, header in ipairs(headers) do
header:remove_node()
end
local paragraph = body:create_element("p", {})
body:add_child_node(paragraph)
paragraph:add_child_node(paragraph:create_text_node("This is a second paragraph"))
for _, el in ipairs(body:get_children()) do
if el:is_element() then
tex.print(el:get_element_name().. ": ".. el:get_text() .. "\\par")
end
end
body:replace_node(oldbody)
\end{luacode*}
\end{framed}
\section{The \texttt{CssQuery} library}
\label{sec:cssquery_library}
This library serves mainly as a support for the
\texttt{DOM\_Object:query\_selector} function. It also supports adding
information to the DOM tree.
\subsection{Example usage}
\begin{verbatim}
local cssobj = require "luaxml-cssquery"
local domobj = require "luaxml-domobject"
local xmltext = [[
<html>
<body>
<h1>Header</h1>
<p>Some text, <i>italics</i></p>
</body>
</html>
]]
local dom = domobj.parse(xmltext)
local css = cssobj()
css:add_selector("h1", function(obj)
print("header found: " .. obj:get_text())
end)
css:add_selector("p", function(obj)
print("paragraph found: " .. obj:get_text())
end)
css:add_selector("i", function(obj)
print("found italics: " .. obj:get_text())
end)
dom:traverse_elements(function(el)
-- find selectors that match the current element
local querylist = css:match_querylist(el)
-- add templates to the element
css:apply_querylist(el,querylist)
end)
\end{verbatim}
\begin{framed}
\begin{luacode*}
local cssobj = require "luaxml-cssquery"
local domobj = require "luaxml-domobject"
local print = function(s) tex.print(s .. "\\par") end
local xmltext = [[
<html>
<body>
<h1>Header</h1>
<p>Some text, <i>italics</i></p>
</body>
</html>
]]
local dom = domobj.parse(xmltext)
local css = cssobj()
css:add_selector("h1", function(obj)
print("header found: " .. obj:get_text())
end)
css:add_selector("p", function(obj)
print("paragraph found: " .. obj:get_text())
end)
css:add_selector("i", function(obj)
print("found italics: " .. obj:get_text())
end)
dom:traverse_elements(function(el)
-- find selectors that match the current element
local querylist = css:match_querylist(el)
-- add templates to the element
css:apply_querylist(el,querylist)
end)
\end{luacode*}
\end{framed}
More complete example may be found in the \texttt{examples} directory in the
\texttt{LuaXML} source code
repository\footnote{\url{https://github.com/michal-h21/LuaXML/blob/master/examples/xmltotex.lua}}.
\section{The \texttt{luaxml-transform} library}
This library is still a bit experimental. It enables XML transformation based
on CSS selector templates.
It isn't nearly as powerful as XSLT, but it may suffice for simpler tasks.
\subsection{Basic example}
\begin{verbatim}
local transform = require "luaxml-transform"
local transformer = transform.new()
local xml_text = [[<section>hello <b>world</b></section>]]
-- transformatio rules
transformer:add_action("section", "\\section{@<.>}")
transformer:add_action("b", "\\textbf{@<.>}")
-- transform and print the result to the document
local result = transformer:parse_xml(xml_text)
transform.print_tex("\\verb|" .. result .. "|")
\end{verbatim}
\begin{framed}
\begin{luacode*}
local transform = require "luaxml-transform"
local transformer = transform.new()
local xml_text = [[<section>hello <b>world</b></section>]]
-- transformatio rules
transformer:add_action("section", "\\section{@<.>}")
transformer:add_action("b", "\\textbf{@<.>}")
-- transform and print the result to the document
local result = transformer:parse_xml(xml_text)
transform.print_tex("\\verb|" .. result .. "|")
\end{luacode*}
\end{framed}
\subsection{The Transform object }
The \texttt{luaxml-transform} library provides several functions.
Most important of them is \verb|new()|. It returns a Transform object,
that can be used for the transformations. It is possible to transform
XML using text templates, or Lua functions. In both cases, actions for
elements are selected using CSS selectors. If there is no action for
an element, it's text content and text from transformed child elements,
is placed to the output string.
There are two methods for action specification, \verb|add_action| for
text templates, and \verb|add_custom_action| for Lua functions.
\subsubsection{Transforming using templates}
Template actions can be added using the \verb|add_action| method:
\begin{verbatim}
transformer:add_action("CSS selector", "template", {parameters table})
\end{verbatim}
For details about CSS selectors, see the \texttt{CssQuery} library
(see page~\pageref{sec:cssquery_library}). Templates can contain
arbitrary text, with special instructions that can insert transformed
text contents of the element, contents of specific element, or element's
attributes.
\noindent\textbf{Instruction syntax:}
\begin{description}
\item[\verb|@\{attribute name\}|] insert value of an attribute
\item[\verb|@<.>|] insert transformed content of the element
\item[\verb|@<number>|] insert transformed content of the child element
selected by it's number in the list of children
\item[\verb|@<element name>|] insert transformed content of the named child element
\end{description}
\noindent\textbf{Parameters}
The parameters table can hold following values:
\begin{description}
\item[verbatim] -- used for source code listings and similar texts, that should keep their original formatting.
Special characters are not escaped, so you will want to transform the elements into verbatim or listings environment.
\item[separator] -- when you select element by names (\verb|@<element name>|), you can use this parameter
set the separator between possible multiple instances of the child element.
\end{description}
\noindent\textbf{Examples:}
\noindent\textbf{Process children}
\begin{verbatim}
local transformer = transform.new()
transformer:add_action("a", "@<.>")
-- ignore element <b>
transformer:add_action("b", "")
local result = transformer:parse_xml("<x><a>hello</a><b>, world</b></x>")
transform.print_tex(result)
\end{verbatim}
\begin{framed}
\begin{luacode*}
local transform = require "luaxml-transform"
local transformer = transform.new()
transformer:add_action("a", "@<.>")
-- ignore element <b>
transformer:add_action("b", "")
local result = transformer:parse_xml("<x><a>hello</a><b>, world</b></x>")
transform.print_tex(result)
\end{luacode*}
\end{framed}
\noindent\textbf{Select elements by their position}
\begin{verbatim}
local transformer = transform.new()
-- swap child elements
transformer:add_action("x", "@<2>, @<1>")
local result = transformer:parse_xml("<x><a>world</a>, <b>hello</b></x>")
transform.print_tex(result)
\end{verbatim}
\begin{framed}
\begin{luacode*}
local transform = require "luaxml-transform"
local transformer = transform.new()
transformer:add_action("x", "@<2>, @<1>")
local result = transformer:parse_xml("<x><a>world</a>, <b>hello</b></x>")
transform.print_tex(result)
\end{luacode*}
\end{framed}
\noindent\textbf{Select elements by name}
\begin{verbatim}
local transformer = transform.new()
transformer:add_action("x", "@<a>")
local result = transformer:parse_xml("<x><a>hello</a><b>, world</b></x>")
transform.print_tex(result)
\end{verbatim}
\begin{framed}
\begin{luacode*}
local transform = require "luaxml-transform"
local transformer = transform.new()
transformer:add_action("x", "@<a>")
local result = transformer:parse_xml("<x><a>hello</a><b>, world</b></x>")
transform.print_tex(result)
\end{luacode*}
\end{framed}
\noindent\textbf{Select attributes}
\begin{verbatim}
local transformer = transform.new()
transformer:add_action("b", "\\textbf{@<.>}")
-- this will select only <b> elements with "style" attribute
transformer:add_action("b[style]", "\\textcolor{@{style}}{\\textbf{@<.>}}")
local text = '<x><b>hello</b> <b style="red">world</b></x>'
local result = transformer:parse_xml(text)
transform.print_tex(result)
\end{verbatim}
\begin{framed}
\begin{luacode*}
local transform = require "luaxml-transform"
local transformer = transform.new()
transformer:add_action("b", "\\textbf{@<.>}")
-- this will select only <b> elements with "style" attribute
transformer:add_action("b[style]", "\\textcolor{@{style}}{\\textbf{@<.>}}")
local text = '<x><b>hello</b> <b style="red">world</b></x>'
local result = transformer:parse_xml(text)
transform.print_tex("\\verb|" .. result .. "|")
\end{luacode*}
\end{framed}
\subsubsection{Transforming using Lua functions}
You can use Lua functions for more complex transformations where simple templates don't suffice.
\begin{verbatim}
transformer:add_custom_action("CSS selector", function)
\end{verbatim}
\noindent\textbf{Example}
\begin{verbatim}
local transformer = transform.new()
local xml_text = "<x><a>world</a><b>hello, </b></x>"
-- load helper functions
local get_child_element = transform.get_child_element
local process_children = transform.process_children
-- define custom action
transformer:add_custom_action("x", function(el)
-- it basically just swaps child elements,
-- like in the template @<2>@<1>
local first = process_children(get_child_element(el, 1))
local second = process_children(get_child_element(el, 2))
return second .. first
end)
local result = transformer:parse_xml(xml_text)
transform.print_tex(result)
\end{verbatim}
\begin{framed}
\begin{luacode*}
local transform = require "luaxml-transform"
local transformer = transform.new()
local xml_text = "<x><a>world</a><b>hello, </b></x>"
-- load helper functions
local get_child_element = transform.get_child_element
local process_children = transform.process_children
-- define custom action
transformer:add_custom_action("x", function(el)
-- it basically just swaps child elements,
-- like in the template @<2>@<1>
local first = process_children(get_child_element(el, 1))
local second = process_children(get_child_element(el, 2))
return second .. first
end)
local result = transformer:parse_xml(xml_text)
transform.print_tex(result)
\end{luacode*}
\end{framed}
\subsubsection{Character handling}
You may want to escape certain characters, or replace them with
\LaTeX\ commands. You can use the \texttt{unicodes} table contained
in the Transform object:
\begin{verbatim}
local transformer = transform.new()
-- you must use the Unicode character code
transformer.unicodes[124] = "\\textbar"
local text = '<x>|</x>'
local result = transformer:parse_xml(text)
transform.print_tex(result)
\end{verbatim}
\begin{framed}
\begin{luacode*}
local transform = require "luaxml-transform"
local transformer = transform.new()
-- you must use the Unicode character code
transformer.unicodes[124] = "\\textbar"
local text = '<x>|</x>'
local result = transformer:parse_xml(text)
transform.print_tex("\\verb|" .. result .. "|")
\end{luacode*}
\end{framed}
\section{The API documentation}
\input{doc/api.tex}
\section{Low-level functions usage}
% The processing is done with several handlers, their usage will be shown in the
% following section. Full description of handlers is given in the original
% documentation in section \ref{sec:handlers}.
% \subsection{Usage examples}
The original |LuaXML| library provides some low-level functions for |XML| handling.
First of all, we need to load the libraries:
\begin{verbatim}
xml = require('luaxml-mod-xml')
handler = require('luaxml-mod-handler')
\end{verbatim}
The |luaxml-mod-xml| file contains the xml parser and also the serializer. In
|luaxml-mod-handler|, various handlers for dealing with xml data are defined.
Handlers transforms the |xml| file to data structures which can be handled from
the Lua code. More information about handlers can be found in the original
documentation, section \ref{sec:handlers}.
\subsection{The simpleTreeHandler}
\begin{verbatim}
sample = [[
<a>
<d>hello</d>
<b>world.</b>
<b at="Hi">another</b>
</a>]]
treehandler = handler.simpleTreeHandler()
x = xml.xmlParser(treehandler)
x:parse(sample)
\end{verbatim}
You have to create handler object, using |handler.simpleTreeHandler()| and xml
parser object using |xml.xmlParser(handler object)|. |simpleTreehandler|
creates simple table hierarchy, with top root node in |treehandler.root|
\begin{verbatim}
-- pretty printing function
function printable(tb, level)
level = level or 1
local spaces = string.rep(' ', level*2)
for k,v in pairs(tb) do
if type(v) ~= "table" then
print(spaces .. k..'='..v)
else
print(spaces .. k)
level = level + 1
printable(v, level)
end
end
end
-- print table
printable(treehandler.root)
-- print xml serialization of table
print(xml.serialize(treehandler.root))
-- direct access to the element
print(treehandler.root["a"]["b"][1])
\end{verbatim}
This code produces the following output:
\begin{verbatim}
output:
a
d=hello
b
1=world.
2
1=another
_attr
at=Hi
<?xml version="1.0" encoding="UTF-8"?>
<a>
<d>hello</d>
<b>world.</b>
<b at="Hi">
another
</b>
</a>
world.
\end{verbatim}
First part is pretty-printed dump of Lua table structure contained in the handler, the second
part is |xml| serialized from that table and the last part demonstrates direct access to particular
elements.
Note that |simpleTreeHandler| creates tables that can be easily accessed using
standard lua functions, but if the xml document is of mixed-content type\footnote{%
This means that element may contain both children elements and text.}:
\begin{verbatim}
<a>hello
<b>world</b>
</a>
\end{verbatim}
\noindent then it produces wrong results. It is useful mostly for data |xml| files, not for
text formats like |xhtml|.
\subsection{The domHandler}
% For complex xml documents with mixed content, |domHandler| is capable of representing any valid XML document:
For complex xml documents, it is best to use the |domHandler|, which creates object which contains all information
from the |xml| document.
\begin{verbatim}
-- file dom-sample.lua
-- next line enables scripts called with texlua to use luatex libraries
--kpse.set_program_name("luatex")
function traverseDom(current,level)
local level = level or 0
local spaces = string.rep(" ",level)
local root= current or current.root
local name = root._name or "unnamed"
local xtype = root._type or "untyped"
local attributes = root._attr or {}
if xtype == "TEXT" then
print(spaces .."TEXT : " .. root._text)
else
print(spaces .. xtype .. " : " .. name)
end
for k, v in pairs(attributes) do
print(spaces .. " ".. k.."="..v)
end
local children = root._children or {}
for _, child in ipairs(children) do
traverseDom(child, level + 1)
end
end
local xml = require('luaxml-mod-xml')
local handler = require('luaxml-mod-handler')
local x = '<p>hello <a href="http://world.com/">world</a>, how are you?</p>'
local domHandler = handler.domHandler()
local parser = xml.xmlParser(domHandler)
parser:parse(x)
traverseDom(domHandler.root)
\end{verbatim}
The ROOT element is stored in |domHandler.root| table, it's child nodes are stored in |_children|
tables. Node type is saved in |_type| field, if the node type is |ELEMENT|, then |_name| field contains
element name, |_attr| table contains element attributes. |TEXT| node contains text content in |_text|
field.
The previous code produces following output in the terminal: % after command
% |texlua dom-sample.lua| running:
\begin{verbatim}
ROOT : unnamed
ELEMENT : p
TEXT : hello
ELEMENT : a
href=http://world.com/
TEXT : world
TEXT : , how are you?
\end{verbatim}
% With \verb|domHandler|, you can process documents with mixed content, like
% \verb|xhtml|, so it is a most powerful handler.
\clearpage
\part{Original \texttt{LuaXML} documentation by Paul Chakravarti}
\medskip
\noindent This document was created automatically from the original source code comments using Pandoc\footnote{\url{http://johnmacfarlane.net/pandoc/}}
\section{Overview}
This module provides a non-validating XML stream parser in Lua.
\section{Features}
\begin{itemize}
\item
Tokenises well-formed XML (relatively robustly)
\item
Flexible handler based event api (see below)
\item
Parses all XML Infoset elements - ie.
\begin{itemize}
\item
Tags
\item
Text
\item
Comments
\item
CDATA
\item
XML Decl
\item
Processing Instructions
\item
DOCTYPE declarations
\end{itemize}
\item
Provides limited well-formedness checking (checks for basic syntax \&
balanced tags only)
\item
Flexible whitespace handling (selectable)
\item
Entity Handling (selectable)
\end{itemize}
\section{Limitations}
\begin{itemize}
\item
Non-validating
\item
No charset handling
\item
No namespace support
\item
Shallow well-formedness checking only (fails to detect most semantic
errors)
\end{itemize}
\section{API}
The parser provides a partially object-oriented API with functionality
split into tokeniser and hanlder components.
The handler instance is passed to the tokeniser and receives callbacks
for each XML element processed (if a suitable handler function is
defined). The API is conceptually similar to the SAX API but implemented
differently.
The following events are generated by the tokeniser
\begin{verbatim}
handler:starttag - Start Tag
handler:endtag - End Tag
handler:text - Text
handler:decl - XML Declaration
handler:pi - Processing Instruction
handler:comment - Comment
handler:dtd - DOCTYPE definition
handler:cdata - CDATA
\end{verbatim}
The function prototype for all the callback functions is
\begin{verbatim}
callback(val,attrs,start,end)
\end{verbatim}
where attrs is a table and val/attrs are overloaded for specific
callbacks - ie.
\begin{tabular}{llp{5cm}}
Callback & val & attrs (table)\\
\hline
starttag & name & |{ attributes (name=val).. }|\\
endtag & name & nil\\
text & |<text>| & nil\\
cdata & |<text> | & nil\\
decl & "xml" & |{ attributes (name=val).. }|\\
pi & pi name & \begin{verbatim}{ attributes (if present)..
_text = <PI Text>
}\end{verbatim}\\
comment & |<text>| & nil\\
dtd & root element & \begin{verbatim}{ _root = <Root Element>,
_type = SYSTEM|PUBLIC,
_name = <name>,
_uri = <uri>,
_internal = <internal dtd>
}\end{verbatim}\\
\end{tabular}
(starttag \& endtag provide the character positions of the start/end of the
element)
XML data is passed to the parser instance through the `parse' method
(Note: must be passed as single string currently)
\section{Options}
Parser options are controlled through the `self.options' table.
Available options are -
\begin{itemize}
\item
stripWS
Strip non-significant whitespace (leading/trailing) and do not
generate events for empty text elements
\item
expandEntities
Expand entities (standard entities + single char numeric entities only
currently - could be extended at runtime if suitable DTD parser added
elements to table (see obj.\_ENTITIES). May also be possible to expand
multibyre entities for UTF--8 only
\item
errorHandler
Custom error handler function
\end{itemize}
NOTE: Boolean options must be set to `nil' not `0'
\section{Usage}
Create a handler instance -
\begin{verbatim}
h = { starttag = function(t,a,s,e) .... end,
endtag = function(t,a,s,e) .... end,
text = function(t,a,s,e) .... end,
cdata = text }
\end{verbatim}
(or use predefined handler - see luaxml-mod-handler.lua)
Create parser instance -
\begin{verbatim}
p = xmlParser(h)
\end{verbatim}
Set options -
\begin{verbatim}
p.options.xxxx = nil
\end{verbatim}
Parse XML data -
\begin{verbatim}
xmlParser:parse("<?xml... ")
\end{verbatim}
\section{Handlers}\label{sec:handlers}
\subsection{Overview}
Standard XML event handler(s) for XML parser module (luaxml-mod-xml.lua)
\subsection{Features}
\begin{verbatim}
printHandler - Generate XML event trace
domHandler - Generate DOM-like node tree
simpleTreeHandler - Generate 'simple' node tree
simpleTeXhandler - SAX like handler with support for CSS selectros
\end{verbatim}
\subsection{API}
Must be called as handler function from xmlParser and implement XML
event callbacks (see xmlParser.lua for callback API definition)
\subsubsection{printHandler}
printHandler prints event trace for debugging
\subsubsection{domHandler}
domHandler generates a DOM-like node tree structure with
a single ROOT node parent - each node is a table comprising
fields below.
\begin{verbatim}
node = { _name = <Element Name>,
_type = ROOT|ELEMENT|TEXT|COMMENT|PI|DECL|DTD,
_attr = { Node attributes - see callback API },
_parent = <Parent Node>
_children = { List of child nodes - ROOT/NODE only }
}
\end{verbatim}
\subsubsection{simpleTreeHandler}
simpleTreeHandler is a simplified handler which attempts to generate a
more `natural' table based structure which supports many common XML
formats.
The XML tree structure is mapped directly into a recursive table
structure with node names as keys and child elements as either a table
of values or directly as a string value for text. Where there is only a
single child element this is inserted as a named key - if there are
multiple elements these are inserted as a vector (in some cases it may
be preferable to always insert elements as a vector which can be
specified on a per element basis in the options). Attributes are
inserted as a child element with a key of `\_attr'.
Only Tag/Text \& CDATA elements are processed - all others are ignored.
This format has some limitations - primarily
\begin{itemize}
\item Mixed-Content behaves unpredictably - the relationship between text
elements and embedded tags is lost and multiple levels of mixed
content does not work
\item If a leaf element has both a text element and attributes then the text
must be accessed through a vector (to provide a container for the
attribute)
\end{itemize}
In general however this format is relatively useful.
\subsection{Options}
\begin{verbatim}
simpleTreeHandler.options.noReduce = { <tag> = bool,.. }
- Nodes not to reduce children vector even if only
one child
domHandler.options.(comment|pi|dtd|decl)Node = bool
- Include/exclude given node types
\end{verbatim}
\subsection{Usage}
Pased as delegate in xmlParser constructor and called as callback by
xmlParser:parse(xml) method.
\section{History}
This library is fork of LuaXML library originaly created by Paul
Chakravarti. Some files not needed for use with luatex were droped from the distribution.
Documentation was converted from original comments in the source code.
\section{License}
This code is freely distributable under the terms of the Lua license
(\url{http://www.lua.org/copyright.html})
\end{document}
|
