talkatu/talkatu

Add TalkatuHtmlParser that abstracts out the traversal of HTML documents to make it easier to output other formats

2020-09-03, Gary Kramlich
f6ba5e577516
Add TalkatuHtmlParser that abstracts out the traversal of HTML documents to make it easier to output other formats

Add an iterative html parser which will be used to create pangomarkup and gtktext later.

Testing Done:
Added some unittests and ran them in valgrind. Also created and checked the docs.

Reviewed at https://reviews.imfreedom.org/r/89/
/*
* talkatu
* Copyright (C) 2017-2019 Gary Kramlich <grim@reaperworld.com>
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 2 of the License, or (at your option) any later version.
*
* This library 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
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, see <http://www.gnu.org/licenses/>.
*/
#include <stdarg.h>
#include <gtk/gtk.h>
#include <pango/pango.h>
#include <talkatu/talkatutag.h>
#include <talkatu/talkatutagtable.h>
/**
* SECTION:talkatutagtable
* @Title: TagTable
* @Short_description: A simple formatting tag_table
*
* Talkatu provides a simple formatting tag_table that gives the user the ability
* to format any #TalkatuBuffer via the formatting actions.
*/
/**
* TALKATU_TYPE_TAG_TABLE:
*
* The standard _get_type macro for #TalkatuTagTable.
*/
/**
* TalkatuTagTable:
*
* A #GtkTextTagTable subclass that is preloaded with all of the #TalkatuTag's.
*/
struct _TalkatuTagTable {
GtkTextTagTable parent;
};
G_DEFINE_TYPE(TalkatuTagTable, talkatu_tag_table, GTK_TYPE_TEXT_TAG_TABLE)
/******************************************************************************
* GObject Stuff
*****************************************************************************/
static void
talkatu_tag_table_init(TalkatuTagTable *table) {
GdkRGBA color = {0.0, 0.0, 0.0, 0.0};
GtkTextTagTable *tag_table = GTK_TEXT_TAG_TABLE(table);
gtk_text_tag_table_add(
tag_table,
talkatu_tag_new(
TALKATU_TAG_BOLD,
"weight", PANGO_WEIGHT_BOLD,
NULL
)
);
gtk_text_tag_table_add(
tag_table,
talkatu_tag_new(
TALKATU_TAG_ITALIC,
"style", PANGO_STYLE_ITALIC,
NULL
)
);
gtk_text_tag_table_add(
tag_table,
talkatu_tag_new(
TALKATU_TAG_UNDERLINE,
"underline", PANGO_UNDERLINE_SINGLE,
NULL
)
);
gtk_text_tag_table_add(
tag_table,
talkatu_tag_new(
TALKATU_TAG_STRIKETHROUGH,
"strikethrough", TRUE,
NULL
)
);
gtk_text_tag_table_add(
tag_table,
talkatu_tag_new(
TALKATU_TAG_SUBSCRIPT,
"rise", -5000,
NULL
)
);
gtk_text_tag_table_add(
tag_table,
talkatu_tag_new(
TALKATU_TAG_SUPERSCRIPT,
"rise", 5000,
NULL
)
);
gtk_text_tag_table_add(
tag_table,
talkatu_tag_new(
TALKATU_TAG_PRE,
"family", "Monospace",
"display", TALKATU_TAG_DISPLAY_BLOCK,
NULL
)
);
gtk_text_tag_table_add(
tag_table,
talkatu_tag_new(
TALKATU_TAG_CODE,
"family", "Monospace",
"paragraph-background", "#C0C0C0",
"display", TALKATU_TAG_DISPLAY_BLOCK,
NULL
)
);
gtk_text_tag_table_add(
tag_table,
talkatu_tag_new(
TALKATU_TAG_SEARCH,
"background", "#22FF00",
"weight", PANGO_WEIGHT_BOLD,
NULL
)
);
gtk_text_tag_table_add(
tag_table,
talkatu_tag_new(
TALKATU_TAG_H1,
"weight", PANGO_WEIGHT_BOLD,
"pixels-above-lines", 11,
"pixels-below-lines", 11,
"scale", 2.0,
"display", TALKATU_TAG_DISPLAY_BLOCK,
NULL
)
);
gtk_text_tag_table_add(
tag_table,
talkatu_tag_new(
TALKATU_TAG_H2,
"weight", PANGO_WEIGHT_BOLD,
"scale", 1.5,
"display", TALKATU_TAG_DISPLAY_BLOCK,
NULL
)
);
gtk_text_tag_table_add(
tag_table,
talkatu_tag_new(
TALKATU_TAG_H3,
"weight", PANGO_WEIGHT_BOLD,
"scale", 1.1699,
"display", TALKATU_TAG_DISPLAY_BLOCK,
NULL
)
);
gtk_text_tag_table_add(
tag_table,
talkatu_tag_new(
TALKATU_TAG_H4,
"weight", PANGO_WEIGHT_BOLD,
"display", TALKATU_TAG_DISPLAY_BLOCK,
NULL
)
);
gtk_text_tag_table_add(
tag_table,
talkatu_tag_new(
TALKATU_TAG_H5,
"weight", PANGO_WEIGHT_BOLD,
"scale", 0.8299,
"display", TALKATU_TAG_DISPLAY_BLOCK,
NULL
)
);
gtk_text_tag_table_add(
tag_table,
talkatu_tag_new(
TALKATU_TAG_H6,
"weight", PANGO_WEIGHT_BOLD,
"scale", 0.67,
"display", TALKATU_TAG_DISPLAY_BLOCK,
NULL
)
);
gdk_rgba_parse(&color, "#0000FF");
gtk_text_tag_table_add(
tag_table,
talkatu_tag_new(
TALKATU_TAG_ANCHOR,
"foreground-rgba", &color,
"underline", PANGO_UNDERLINE_SINGLE,
"underline-rgba", &color,
NULL
)
);
gtk_text_tag_table_add(
tag_table,
talkatu_tag_new(
TALKATU_TAG_DL,
"display", TALKATU_TAG_DISPLAY_BLOCK,
"pixels-inside-wrap", 12,
NULL
)
);
gtk_text_tag_table_add(
tag_table,
talkatu_tag_new(
TALKATU_TAG_DL TALKATU_TAG_FORMATTING_START,
"pixels-above-lines", 12, /* needs to be dynamic the font's point size */
NULL
)
);
gtk_text_tag_table_add(
tag_table,
talkatu_tag_new(
TALKATU_TAG_DL TALKATU_TAG_FORMATTING_END,
"pixels-below-lines", 12, /* needs to be dynamic the font's point size */
NULL
)
);
gtk_text_tag_table_add(
tag_table,
talkatu_tag_new(
TALKATU_TAG_DT,
"display", TALKATU_TAG_DISPLAY_BLOCK,
NULL
)
);
gtk_text_tag_table_add(
tag_table,
talkatu_tag_new(
TALKATU_TAG_DD,
"left-margin", 40,
"display", TALKATU_TAG_DISPLAY_BLOCK,
NULL
)
);
/* these tags are just used as markers and don't provide any formatting */
gtk_text_tag_table_add(
tag_table,
gtk_text_tag_new(TALKATU_TAG_MESSAGE)
);
gtk_text_tag_table_add(
tag_table,
gtk_text_tag_new(TALKATU_TAG_TIMESTAMP)
);
gtk_text_tag_table_add(
tag_table,
gtk_text_tag_new(TALKATU_TAG_AUTHOR)
);
gtk_text_tag_table_add(
tag_table,
gtk_text_tag_new(TALKATU_TAG_CONTENTS)
);
}
static void
talkatu_tag_table_class_init(TalkatuTagTableClass *klass) {
}
/******************************************************************************
* Public API
*****************************************************************************/
/**
* talkatu_tag_table_new:
*
* Creates a new #TalkatuTagTable that provides the user with an interface to
* control the formatting of a #TalkatuBuffer.
*
* Returns: (transfer full): The new #TalkatuTagTable instance.
*/
GtkTextTagTable *talkatu_tag_table_new(void) {
return GTK_TEXT_TAG_TABLE(g_object_new(
TALKATU_TYPE_TAG_TABLE,
NULL
));
}