1/*
2 * Copyright (c) 2015-2017, 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 Corpus Generation tool.
31 */
32
33#ifndef NG_CORPUS_GENERATOR_H_
34#define NG_CORPUS_GENERATOR_H_
35
36#include "ng_corpus_properties.h"
37
38#include <memory>
39#include <string>
40#include <vector>
41
42namespace ue2 {
43
44class ExpressionInfo;
45class NGHolder;
46
47} // namespace ue2
48
49struct CorpusGenerationFailure {
50 explicit CorpusGenerationFailure(const std::string s) :
51 message(std::move(s)) {}
52 std::string message;
53};
54
55/** \brief Abstract interface to corpus generator tool. */
56class CorpusGenerator {
57public:
58 virtual ~CorpusGenerator();
59
60 /** \brief Build some corpora.
61 *
62 * Generate a set of corpora, placed in the \a data vector, for the current
63 * NFAGraph according to the parameters provided by the CorpusProperties
64 * object. Returns the number of corpora generated.
65 */
66 virtual void generateCorpus(std::vector<std::string> &data) = 0;
67};
68
69/** \brief Build a concrete impl conforming to the \ref CorpusGenerator
70 * interface. */
71std::unique_ptr<CorpusGenerator>
72makeCorpusGenerator(const ue2::NGHolder &g, const ue2::ExpressionInfo &expr,
73 CorpusProperties &props);
74
75#endif
76