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#ifndef SMWR_BUILD_H
30#define SMWR_BUILD_H
31
32/**
33 * \file
34 * \brief Small-write engine build interface.
35 *
36 * Everything you ever needed to feed literals in and get a SmallWriteEngine
37 * out. This header should be everything needed by the rest of UE2.
38 */
39
40#include "ue2common.h"
41#include "util/bytecode_ptr.h"
42#include "util/noncopyable.h"
43
44#include <memory>
45#include <set>
46
47struct SmallWriteEngine;
48
49namespace ue2 {
50
51struct CompileContext;
52struct ue2_literal;
53class ExpressionInfo;
54class NGHolder;
55class ReportManager;
56
57/**
58 * Abstract interface intended for callers from elsewhere in the tree, real
59 * underlying implementation is SmallWriteBuildImpl in smwr_build_impl.h.
60 */
61class SmallWriteBuild : noncopyable {
62public:
63 virtual ~SmallWriteBuild();
64
65 virtual bytecode_ptr<SmallWriteEngine> build(u32 roseQuality) = 0;
66
67 virtual void add(const NGHolder &g, const ExpressionInfo &expr) = 0;
68 virtual void add(const ue2_literal &literal, ReportID r) = 0;
69
70 virtual std::set<ReportID> all_reports() const = 0;
71};
72
73/** \brief Construct a usable SmallWrite builder. */
74std::unique_ptr<SmallWriteBuild>
75makeSmallWriteBuilder(size_t num_patterns, const ReportManager &rm,
76 const CompileContext &cc);
77
78} // namespace ue2
79
80#endif // SMWR_BUILD_H
81