File: generator.h

package info (click to toggle)
dbus-cpp 5.0.5-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 1,208 kB
  • sloc: cpp: 9,427; ansic: 2,012; xml: 1,156; makefile: 14; sh: 2
file content (74 lines) | stat: -rw-r--r-- 2,337 bytes parent folder | download | duplicates (3)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
/*
 * Copyright © 2012 Canonical Ltd.
 *
 * This program is free software: you can redistribute it and/or modify it
 * under the terms of the GNU Lesser General Public License version 3,
 * as published by the Free Software Foundation.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 *
 * Authored by: Thomas Voß <thomas.voss@canonical.com>
 */
#ifndef CORE_DBUS_GENERATOR_H_
#define CORE_DBUS_GENERATOR_H_

#include <core/dbus/compiler.h>

#include <fstream>
#include <functional>
#include <memory>

namespace core
{
namespace dbus
{
struct GeneratorConfiguration;

/**
 * @brief Interface and implementation to generate boilerplate bindings code for interfacing with DBus services.
 */
class Generator
{
  public:
    /**
     * @brief Specifies the default generator configuration.
     * @return An instance of the default generator configuration.
     */
    static const GeneratorConfiguration& default_configuration();

    /**
     * @brief Constructs a default generator.
     */
    Generator();
    Generator(const Generator&) = delete;
    virtual ~Generator();

    bool operator==(const Generator&) const = delete;
    Generator& operator=(const Generator&) = delete;

    /**
     * @brief Invokes the generator for the supplied root element and configuration.
     * @param element The root element that the generator should start with.
     * @param raw_file_contents The raw file contents that the intermediate model has been parsed from.
     * @param config The configuration of the generator.
     * @return true if the final binding boilerplate code has been generated successfully, false otherwise.
     */
    virtual bool invoke_for_model_with_configuration(
            const std::shared_ptr<Compiler::Element>& element,
            std::istream& raw_file_contents,
            const GeneratorConfiguration& config = default_configuration());

  private:
    struct Private;
    std::unique_ptr<Private> d;
};
}
}

#endif // CORE_DBUS_GENERATOR_H_