summaryrefslogtreecommitdiff
path: root/tests/README-description.txt
blob: 4e854c4e597dceb1f3ce53ef00d4226c8029013d (plain)
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
This file describes the tests present in the libcroro tests directory.
=====================================================================

Initial author: Dodji Seketeli <dodji@seketeli.org>

Each entry of this file is orgnised as follows:

"""""""""""""""""""""""""""""""""""""""""""""""""
binary: name-of-the-test-binary-file

source-file: name-of-the-test-source-file

purpose: purpose of the test.

description: description of the test
"""""""""""""""""""""""""""""""""""""""""""""""""

And, in the words of RMS, happy hacking !

      Dodji
##################################################################


"""""""""""""""""""""""""""""""""""""""""""""""""
binary: test0

source-file: test0-main.c

purpose: Tests the cr_input_read_byte() method of the CRInput class.

description: opens the file located at the path in parameter and
loads it into an input stream using the cr_input_new_from_uri() 
method of the CRInput class.
Then, reads the bytes from the input stream using the cr_input_read_byte()
method and dumps each byte read to stdout.
Note that the input file must be encoded in utf8.

"""""""""""""""""""""""""""""""""""""""""""""""""


"""""""""""""""""""""""""""""""""""""""""""""""""
binary: test1

source-file: test1-main.c

purpose: Test the read_char() method of the CRInput class.

description: opens the file located at the path in parameter and
loads it into an input stream using the cr_input_new_from_uri() 
method of the CRInput class.
Then, reads characters from the input stream using the cr_input_read_char()
method and dumps each character on stdout.
Note that the input file must be encoded in utf8.
"""""""""""""""""""""""""""""""""""""""""""""""""

"""""""""""""""""""""""""""""""""""""""""""""""""
binary: test2

source-file: test2-main.c

purpose: tests the sac api of the parser.

description: it loads the file located at the path given
in argument, instanciates a sac parser, set document
handlers and parses the file. 
The doc handlers simply dump the name name of the callback
which is being called and some basic additional information.
"""""""""""""""""""""""""""""""""""""""""""""""""

"""""""""""""""""""""""""""""""""""""""""""""""""
binary: test3

source-file: test3-main.c

purpose: Test the SAC api core css grammar parsing

description: it loads the file located at the path given
in argument, instanciates a sac parser, set document
handlers and parses the file using the css2 core  syntax.
The doc handlers simply dump the name name of the callback
which is being called and some basic additional information.
Here, the goal is that nothing is dump on screen because
during the parsing using the core grammar syntax, no callback
should be called.
"""""""""""""""""""""""""""""""""""""""""""""""""

"""""""""""""""""""""""""""""""""""""""""""""""""
binary: test4

source-file: test4-main.c

purpose: tests the cssom parser interface (cr-om-parser.c)

description: parses the file located at the path given in
parameter and dumps the result of the parsing (the object model)
on stdout.
"""""""""""""""""""""""""""""""""""""""""""""""""

"""""""""""""""""""""""""""""""""""""""""""""""""
binary: test5

source-file: test5-main.c

purpose: tests the selector cr-sel-eng.c basic functionalities.

description: parses an in memory xml document hardwired in the
test5-main.c file; parses the stylesheet given in parameter to
the test5 binary.
Walks down the xml document tree and runs the selector engine
on each xml documument node to get the css rule that matches it.
Displays a report that basically say: "this xml node was matched
by this set of css rules"
"""""""""""""""""""""""""""""""""""""""""""""""""

"""""""""""""""""""""""""""""""""""""""""""""""""
binary: test6

source-file: test6-main.c

purpose: tests the "in memory" css2 parsing capabilites. (cr_om_parser_parse_buf)


description: parses an "in memory" hardwired css2 stylesheet
and dumps it on stdout.
"""""""""""""""""""""""""""""""""""""""""""""""""