1/*
2 * nghttp3
3 *
4 * Copyright (c) 2019 nghttp3 contributors
5 * Copyright (c) 2017 ngtcp2 contributors
6 *
7 * Permission is hereby granted, free of charge, to any person obtaining
8 * a copy of this software and associated documentation files (the
9 * "Software"), to deal in the Software without restriction, including
10 * without limitation the rights to use, copy, modify, merge, publish,
11 * distribute, sublicense, and/or sell copies of the Software, and to
12 * permit persons to whom the Software is furnished to do so, subject to
13 * the following conditions:
14 *
15 * The above copyright notice and this permission notice shall be
16 * included in all copies or substantial portions of the Software.
17 *
18 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
19 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
20 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
21 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
22 * LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
23 * OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
24 * WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
25 */
26#ifndef NGHTTP3_RANGE_H
27#define NGHTTP3_RANGE_H
28
29#ifdef HAVE_CONFIG_H
30#  include <config.h>
31#endif /* HAVE_CONFIG_H */
32
33#include <nghttp3/nghttp3.h>
34
35/*
36 * nghttp3_range represents half-closed range [begin, end).
37 */
38typedef struct nghttp3_range {
39  uint64_t begin;
40  uint64_t end;
41} nghttp3_range;
42
43/*
44 * nghttp3_range_init initializes |r| with the range [|begin|, |end|).
45 */
46void nghttp3_range_init(nghttp3_range *r, uint64_t begin, uint64_t end);
47
48/*
49 * nghttp3_range_intersect returns the intersection of |a| and |b|.
50 * If they do not overlap, it returns empty range.
51 */
52nghttp3_range nghttp3_range_intersect(const nghttp3_range *a,
53                                      const nghttp3_range *b);
54
55/*
56 * nghttp3_range_len returns the length of |r|.
57 */
58uint64_t nghttp3_range_len(const nghttp3_range *r);
59
60/*
61 * nghttp3_range_eq returns nonzero if |a| equals |b|, such that
62 * a->begin == b->begin, and a->end == b->end hold.
63 */
64int nghttp3_range_eq(const nghttp3_range *a, const nghttp3_range *b);
65
66/*
67 * nghttp3_range_cut returns the left and right range after removing
68 * |b| from |a|.  This function assumes that |a| completely includes
69 * |b|.  In other words, a->begin <= b->begin and b->end <= a->end
70 * hold.
71 */
72void nghttp3_range_cut(nghttp3_range *left, nghttp3_range *right,
73                       const nghttp3_range *a, const nghttp3_range *b);
74
75/*
76 * nghttp3_range_not_after returns nonzero if the right edge of |a|
77 * does not go beyond of the right edge of |b|.
78 */
79int nghttp3_range_not_after(const nghttp3_range *a, const nghttp3_range *b);
80
81#endif /* NGHTTP3_RANGE_H */
82