this repo has no description
dekker.one
1/* -*- mode: C++; c-basic-offset: 2; indent-tabs-mode: nil -*- */
2/*
3 * Main authors:
4 * Guido Tack <tack@gecode.org>
5 *
6 * Copyright:
7 * Guido Tack, 2010
8 *
9 * This file is part of Gecode, the generic constraint
10 * development environment:
11 * http://www.gecode.org
12 *
13 * Permission is hereby granted, free of charge, to any person obtaining
14 * a copy of this software and associated documentation files (the
15 * "Software"), to deal in the Software without restriction, including
16 * without limitation the rights to use, copy, modify, merge, publish,
17 * distribute, sublicense, and/or sell copies of the Software, and to
18 * permit persons to whom the Software is furnished to do so, subject to
19 * the following conditions:
20 *
21 * The above copyright notice and this permission notice shall be
22 * included in all copies or substantial portions of the Software.
23 *
24 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
25 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
26 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
27 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
28 * LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
29 * OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
30 * WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
31 *
32 */
33
34#ifndef GECODE_FLATZINC_PLUGIN_HH
35#define GECODE_FLATZINC_PLUGIN_HH
36
37#ifdef GECODE_HAS_QT
38#include <QtCore>
39#include <QPluginLoader>
40#include <QLibrary>
41
42namespace Gecode { namespace FlatZinc {
43 /**
44 * \brief Interface for branch plugins
45 *
46 * This interface has to be implemented as a Qt Plugin. It then
47 * provides custom branch methods that can be loaded at runtime
48 * from a FlatZinc file.
49 *
50 * In order to use a custom branching, add an annotation to the
51 * FlatZinc solve item like the following:
52 *
53 * ::gecode_search(mybranch(some,arguments,x,y,z))
54 *
55 * This will load the plugin called mybranch and invoke its branch
56 * method with the arguments encoded in an AST.
57 *
58 * The plugin mybranch must reside in a file called mybranch.dll
59 * on Windows, libmybranch.dylib on Mac OS and libmybranch.so on
60 * Linux systems.
61 *
62 * An example plugin can be found in the Gecode source tree under
63 * gecode/flatzinc/exampleplugin.
64 *
65 */
66 class GECODE_VTABLE_EXPORT BranchPlugin {
67 public:
68 /// The custom branch method that this plugin provides
69 virtual void branch(Gecode::FlatZinc::FlatZincSpace& s,
70 Gecode::FlatZinc::AST::Call* c) = 0;
71 };
72}}
73Q_DECLARE_INTERFACE(Gecode::FlatZinc::BranchPlugin,
74 "org.gecode.FlatZinc.BranchPlugin/1.0");
75#endif
76
77#endif
78
79// STATISTICS: flatzinc-any