1/*
2 * Copyright (c) 2015, Intel Corporation
3 *
4 * Redistribution and use in source and binary forms, with or without
5 * modification, are permitted provided that the following conditions are met:
6 *
7 * * Redistributions of source code must retain the above copyright notice,
8 * this list of conditions and the following disclaimer.
9 * * Redistributions in binary form must reproduce the above copyright
10 * notice, this list of conditions and the following disclaimer in the
11 * documentation and/or other materials provided with the distribution.
12 * * Neither the name of Intel Corporation nor the names of its contributors
13 * may be used to endorse or promote products derived from this software
14 * without specific prior written permission.
15 *
16 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
17 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
20 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
21 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
22 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
23 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
24 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
25 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
26 * POSSIBILITY OF SUCH DAMAGE.
27 */
28
29#ifndef NFA_BUILD_UTIL_H
30#define NFA_BUILD_UTIL_H
31
32#include "ue2common.h"
33#include "nfa_internal.h"
34
35#include <string>
36
37struct NFA;
38
39namespace ue2 {
40
41#ifdef DUMP_SUPPORT
42/* provided for debugging functions */
43const char *nfa_type_name(NFAEngineType type);
44std::string describe(const NFA &nfa);
45#endif
46
47// For a given NFA, retrieve the alignment required by its uncompressed state.
48u32 state_alignment(const NFA &nfa);
49
50/* returns true if the nfa is considered 'fast'. TODO: work out what we mean by
51 * fast. */
52bool is_fast(const NFA &n);
53
54bool has_bounded_repeats_other_than_firsts(const NFA &n);
55
56bool has_bounded_repeats(const NFA &n);
57
58bool has_accel(const NFA &n);
59
60bool requires_decompress_key(const NFA &n);
61
62} // namespace ue2
63
64#endif
65