summaryrefslogtreecommitdiffstats
path: root/src/attribute-rel-util.h
blob: 1ad7a85b80b1249f17bad67c84c3a01e00379089 (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
// SPDX-License-Identifier: GPL-2.0-or-later
/** @file
 * TODO: insert short description here
 *//*
 * Authors: see git history
 *
 * Copyright (C) 2016 Authors
 * Released under GNU GPL v2+, read the file 'COPYING' for more information.
 */
#ifndef __SP_ATTRIBUTE_REL_UTIL_H__
#define __SP_ATTRIBUTE_REL_UTIL_H__

/*
 * attribute-rel-util.h
 *
 *  Created on: Sep 8, 2011
 *      Author: tavmjong
 */

#include <glibmm/ustring.h>
#include "xml/sp-css-attr.h"

using Inkscape::XML::Node;

/**
 * Utility functions for cleaning XML tree.
 */

/**
 * Enum for preferences
 */
enum SPAttrClean {
  SP_ATTRCLEAN_ATTR_WARN      =  1,
  SP_ATTRCLEAN_ATTR_REMOVE    =  2,
  SP_ATTRCLEAN_STYLE_WARN     =  4,
  SP_ATTRCLEAN_STYLE_REMOVE   =  8,
  SP_ATTRCLEAN_DEFAULT_WARN   = 16,
  SP_ATTRCLEAN_DEFAULT_REMOVE = 32
};

/**
 * Get preferences
 */
unsigned int sp_attribute_clean_get_prefs();

/**
 * Remove or warn about inappropriate attributes and useless style properties.
 * repr: the root node in a document or any other node.
 */
void sp_attribute_clean_tree(Node *repr);

/**
 * Recursively clean.
 * repr: the root node in a document or any other node.
 * pref_attr, pref_style, pref_defaults: ignore, delete, or warn.
 */
void sp_attribute_clean_recursive(Node *repr, unsigned int flags);

/**
 * Clean one element (attributes and style properties).
 */
void sp_attribute_clean_element(Node *repr, unsigned int flags);

/**
 * Clean style properties for one element.
 */
void sp_attribute_clean_style(Node *repr, unsigned int flags);

/**
 * Clean style properties for one style string.
 */
Glib::ustring sp_attribute_clean_style(Node *repr, gchar const *string, unsigned int flags);

/**
 * Clean style properties for one CSS.
 */
void sp_attribute_clean_style(Node* repr, SPCSSAttr *css, unsigned int flags);

/**
 * Remove CSS style properties with default values.
 */
void sp_attribute_purge_default_style(SPCSSAttr *css, unsigned int flags);

/**
 * Check one attribute on an element
 */
bool sp_attribute_check_attribute(Glib::ustring element, Glib::ustring id, Glib::ustring attribute, bool warn);

#endif /* __SP_ATTRIBUTE_REL_UTIL_H__ */

/*
  Local Variables:
  mode:c++
  c-file-style:"stroustrup"
  c-file-offsets:((innamespace . 0)(inline-open . 0)(case-label . +))
  indent-tabs-mode:nil
  fill-column:99
  End:
*/
// vim: filetype=cpp:expandtab:shiftwidth=4:tabstop=8:softtabstop=4:fileencoding=utf-8:textwidth=99 :