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 /** \file
30  * \brief Build code for McClellan DFA.
31  */
32 
33 #ifndef NG_MCCLELLAN_H
34 #define NG_MCCLELLAN_H
35 
36 #include "ue2common.h"
37 
38 #include <memory>
39 #include <vector>
40 
41 namespace ue2 {
42 
43 class CharReach;
44 class NGHolder;
45 class ReportManager;
46 struct Grey;
47 struct raw_dfa;
48 
49 /**
50  * \brief Determinises an NFA Graph into a raw_dfa.
51  *
52  * \param g
53  *      The NGHolder.
54  * \param rm
55  *      A pointer to the ReportManager, if managed reports are used (e.g.
56  *      for outfixes/suffixes). Otherwise nullptr.
57  * \param single_trigger
58  *      True if it is known that the nfa will only ever be trigger once.
59  * \param triggers
60  *      Representing when tops may arrive. Only used by NFA_INFIX and
61  *      NFA_SUFFIX, should be empty for other types.
62  * \param grey
63  *      Grey box object.
64  * \param finalChance
65  *      Allows us to build bigger DFAs as the only alternative is an outfix.
66  *
67  * \return A raw_dfa, or nullptr on failure (state limit blown).
68  */
69 std::unique_ptr<raw_dfa> buildMcClellan(const NGHolder &g,
70                           const ReportManager *rm, bool single_trigger,
71                           const std::vector<std::vector<CharReach>> &triggers,
72                           const Grey &grey, bool finalChance = false);
73 
74 /** Convenience wrapper for non-triggered engines */
75 std::unique_ptr<raw_dfa> buildMcClellan(const NGHolder &g,
76                                         const ReportManager *rm,
77                                         const Grey &grey);
78 
79 } // namespace ue2
80 
81 #endif // NG_MCCLELLAN_H
82