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
|
/*
Copyright (©) 2003-2025 Teus Benschop.
This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 3 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program; if not, write to the Free Software
Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
*/
#include <html/text.h>
#include <filter/string.h>
#include <filter/url.h>
#include <filter/url.h>
#include <database/books.h>
// Class for creating Html text documents.
HtmlText::HtmlText (const std::string& title)
{
// <html>
pugi::xml_node root_node = document.append_child ("html");
// <head>
pugi::xml_node head_node {root_node.append_child ("head")};
pugi::xml_node title_node = head_node.append_child ("title");
title_node.text ().set (title.c_str());
// <meta http-equiv="content-type" content="text/html; charset=UTF-8" />
pugi::xml_node meta_node = head_node.append_child ("meta");
meta_node.append_attribute ("http-equiv") = "content-type";
meta_node.append_attribute ("content") = "text/html; charset=UTF-8";
// <meta name="viewport" content="width=device-width, initial-scale=1.0">
// This tag helps to make the page mobile-friendly.
// See https://www.google.com/webmasters/tools/mobile-friendly/
meta_node = head_node.append_child ("meta");
meta_node.append_attribute ("name") = "viewport";
meta_node.append_attribute ("content") = "width=device-width, initial-scale=1.0";
// <link rel="stylesheet" type="text/css" href="stylesheet.css">
pugi::xml_node link_node = head_node.append_child ("link");
link_node.append_attribute ("rel") = "stylesheet";
link_node.append_attribute ("type") = "text/css";
link_node.append_attribute ("href") = "stylesheet.css";
// <body>
body_node = root_node.append_child ("body");
// Optional for notes: <div>
notes_div_node = body_node.append_child ("div");
}
void HtmlText::new_paragraph (const std::string& style)
{
// First close a previous paragraph, if there's any open.
if (current_p_node_open) {
// Deal with a blank line.
// If the paragraph is empty, add a <br> to it.
if (current_paragraph_content.empty()) {
current_p_node.append_child("br");
}
}
// Secondly open the paragraph.
current_p_node = body_node.append_child ("p");
if (!style.empty()) {
std::string clss = style;
if (!custom_class.empty()) {
clss.append (" " + custom_class);
}
current_p_node.append_attribute ("class") = clss.c_str();
}
current_p_node_open = true;
current_paragraph_style = style;
current_paragraph_content.clear();
}
// This function adds text to the current paragraph.
// $text: The text to add.
void HtmlText::add_text (const std::string& text)
{
if (!text.empty()) {
if (!current_p_node_open)
new_paragraph ();
pugi::xml_node span = current_p_node.append_child ("span");
span.text().set (text.c_str());
if (!current_text_style.empty ()) {
// Take character style(s) as specified in the object.
span.append_attribute ("class") = filter::strings::implode (current_text_style, " ").c_str();
}
current_paragraph_content.append(text);
}
}
// This creates a <h1> heading with contents.
// $text: Contents.
void HtmlText::new_heading1 (const std::string& text)
{
new_named_heading ("h1", text);
}
// This applies a page break.
void HtmlText::new_page_break ()
{
// The style is already in the css.
new_paragraph ("break");
// Always clear the flag for the open paragraph,
// because we don't want subsequent text to be added to this page break,
// since it would be nearly invisible, and thus text would seem to be lost.
current_p_node_open = false;
current_paragraph_style.clear();
current_paragraph_content.clear();
}
// This opens a text style.
// $style: the array containing the style variables.
// $note: boolean: Whether this refers to notes.
// $embed: boolean: Whether to embed the new text style in an existing text style.
// true: add the new style to the existing style.
// false: close any existing text style, and open the new style.
void HtmlText::open_text_style (const stylesv2::Style* stylev2,
const bool note, const bool embed)
{
const auto get_marker = [stylev2]() {
if (stylev2)
return stylev2->marker;
return std::string();
};
const std::string marker = get_marker();
if (note) {
if (!embed)
current_note_text_style.clear();
current_note_text_style.push_back (marker);
} else {
if (!embed)
current_text_style.clear();
current_text_style.push_back (marker);
}
}
// This closes any open text style.
// $note: boolean: Whether this refers to notes.
// $embed: boolean: Whether to embed the new text style in an existing text style.
// true: add the new style to the existing style.
// false: close any existing text style, and open the new style.
void HtmlText::close_text_style (const bool note, const bool embed)
{
if (note) {
if (!current_note_text_style.empty())
current_note_text_style.pop_back ();
if (!embed)
current_note_text_style.clear();
} else {
if (!current_text_style.empty())
current_text_style.pop_back ();
if (!embed)
current_text_style.clear ();
}
}
// This function adds a note to the current paragraph.
// $citation: The text of the note citation.
// $style: Style name for the paragraph in the note body.
// $endnote: Whether this is a footnote and cross reference (false), or an endnote (true).
void HtmlText::add_note (const std::string& citation, const std::string& style, [[maybe_unused]] const bool endnote)
{
// Ensure that a paragraph is open, so that the note can be added to it.
if (!current_p_node_open)
new_paragraph ();
note_count++;
// Add the link with all relevant data for the note citation.
{
const std::string reference = "#note" + std::to_string (note_count);
const std::string identifier = "citation" + std::to_string (note_count);
add_link (current_p_node, reference, identifier, "", "superscript", citation, add_popup_notes);
}
// Open a paragraph element for the note body.
note_p_node = notes_div_node.append_child ("p");
note_p_node.append_attribute ("class") = style.c_str();
note_p_node_open = true;
close_text_style (true, false);
// Add the link with all relevant data for the note body.
{
const std::string reference = "#citation" + std::to_string (note_count);
const std::string identifier = "note" + std::to_string (note_count);
add_link (note_p_node, reference, identifier, "", "", citation);
}
// Add a space.
add_note_text (" ");
}
// This function adds text to the current footnote.
// $text: The text to add.
void HtmlText::add_note_text (const std::string& text)
{
if (text.empty())
return;
if (!note_p_node_open)
add_note ("?", "");
pugi::xml_node span_node1 = note_p_node.append_child ("span");
span_node1.text().set (text.c_str());
if (!current_note_text_style.empty ()) {
// Take character style as specified in this object.
span_node1.append_attribute ("class") = filter::strings::implode (current_note_text_style, " ").c_str();
}
if (popup_node) {
pugi::xml_node span_node2 = popup_node.append_child ("span");
span_node2.text().set (text.c_str());
}
}
// This function closes the current footnote.
void HtmlText::close_current_note ()
{
close_text_style (true, false);
note_p_node_open = false;
}
// This adds a link.
// $domNode: The DOM node where to add the link to.
// $reference: The link's href, e.g. where it links to.
// $identifier: The link's identifier. Others can link to it.
// $title: The link's title, to make it accessible, e.g. for screenreaders.
// $style: The link text's style.
// $text: The link's text.
void HtmlText::add_link (pugi::xml_node node,
const std::string& reference, const std::string& identifier,
const std::string& title, const std::string& style, const std::string& text,
const bool add_popup)
{
pugi::xml_node a_node = node.append_child ("a");
a_node.append_attribute ("href") = reference.c_str();
a_node.append_attribute ("id") = identifier.c_str();
if (!title.empty ())
a_node.append_attribute ("title") = title.c_str();
if (!style.empty())
a_node.append_attribute ("class") = style.c_str();
pugi::xml_node pcdata = a_node.append_child (pugi::node_pcdata);
pcdata.set_value(text.c_str());
// Whether to add a popup span in a note.
if (add_popup) {
popup_node = a_node.append_child("span");
popup_node.append_attribute("class") = "popup";
}
}
// This gets and then returns the html text
std::string HtmlText::get_html ()
{
// Move any notes into place: At the end of the body.
// Or remove empty notes container.
if (note_count) {
body_node.append_move (notes_div_node);
} else {
body_node.remove_child (notes_div_node);
}
note_count = 0;
// Get the html.
std::stringstream output {};
document.print (output, "", pugi::format_raw);
std::string html = output.str ();
// Add html5 doctype.
html.insert (0, "<!DOCTYPE html>\n");
return html;
}
// Returns the html text within the <body> tags, that is, without the <head> stuff.
std::string HtmlText::get_inner_html ()
{
std::string page = get_html ();
if (const auto pos1 = page.find ("<body>");
pos1 != std::string::npos) {
page = page.substr (pos1 + 6);
if (const auto pos2 = page.find ("</body>");
pos2 != std::string::npos) {
page = page.substr (0, pos2);
}
}
return page;
}
// This saves the web page to file
// $name: the name of the file to save to.
void HtmlText::save (const std::string& name)
{
const std::string html = get_html ();
filter_url_file_put_contents (name, html);
}
// This adds a new table to the html DOM.
// Returns: The new $tableElement
pugi::xml_node HtmlText::new_table ()
{
// Adding subsequent text should create a new paragraph.
current_p_node_open = false;
current_paragraph_style.clear();
current_paragraph_content.clear();
// Append the table.
pugi::xml_node table_element = body_node.append_child ("table");
table_element.append_attribute ("width") = "100%";
return table_element;
}
// This adds a new row to an existing $table_element.
// Returns: The new $table_row_element.
pugi::xml_node HtmlText::new_table_row (pugi::xml_node table_element)
{
pugi::xml_node table_row_element = table_element.append_child ("tr");
return table_row_element;
}
// This adds a new data cell to an existing $table_row_element.
// Returns: The new $table_data_element.
pugi::xml_node HtmlText::new_table_data (pugi::xml_node table_row_element, const bool align_right)
{
pugi::xml_node table_data_element = table_row_element.append_child ("td");
if (align_right)
table_data_element.append_attribute ("align") = "right";
return table_data_element;
}
// This creates a heading with styled content.
// $style: A style name.
// $text: Content.
void HtmlText::new_named_heading (const std::string& style, const std::string& text)
{
pugi::xml_node text_h_dom_element = body_node.append_child (style.c_str());
text_h_dom_element.text ().set (text.c_str());
// Make paragraph null, so that adding subsequent text creates a new paragraph.
current_p_node_open = false;
current_paragraph_style.clear ();
current_paragraph_content.clear ();
}
// Whether to add pop-up notes as well.
void HtmlText::have_popup_notes ()
{
add_popup_notes = true;
}
// Add an image to the html.
void HtmlText::add_image (const std::string& style,
const std::string& alt,
const std::string& src,
const std::string& caption)
{
pugi::xml_node img_node = body_node.append_child ("img");
img_node.append_attribute("alt") = alt.c_str();
img_node.append_attribute("src") = src.c_str();
img_node.append_attribute ("width") = "100%";
// Add the caption if it is given.
if (!caption.empty()) {
new_paragraph(style);
add_text(caption);
}
// Close the paragraph so that adding subsequent text creates a new paragraph.
current_p_node_open = false;
current_paragraph_style.clear ();
current_paragraph_content.clear ();
}
|
