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

#include <string>

/**
 * Parse functional URI notation, as per 4.3.4 of CSS 2.1
 *
 * http://www.w3.org/TR/CSS21/syndata.html#uri
 *
 * > The format of a URI value is 'url(' followed by optional white space
 * > followed by an optional single quote (') or double quote (") character
 * > followed by the URI itself, followed by an optional single quote (')
 * > or double quote (") character followed by optional white space
 * > followed by ')'. The two quote characters must be the same.
 *
 * Example:
 * \verbatim
   url = extract_uri("url('foo')bar", &out);
   -> url == "foo"
   -> out == "bar"
   \endverbatim
 *
 * @param s String which starts with "url("
 * @param[out] endptr points to \c s + N, where N is the number of characters parsed
 * @return URL string, or empty string on failure
 */
std::string extract_uri(char const *s, char const **endptr = nullptr);


#endif /* !SEEN_EXTRACT_URI_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 :