mirror of https://github.com/djcb/mu.git
90 lines
2.1 KiB
C++
90 lines
2.1 KiB
C++
/*
|
|
** Copyright (C) 2020-2023 Dirk-Jan C. Binnema <djcb@djcbsoftware.nl>
|
|
**
|
|
** This program is free software; you can redistribute it and/or modify it
|
|
** under the terms of the GNU General Public License as published by the
|
|
** Free Software Foundation; either version 3, or (at your option) any
|
|
** later version.
|
|
**
|
|
** 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 General Public License for more details.
|
|
**
|
|
** You should have received a copy of the GNU General Public License
|
|
** along with this program; if not, write to the Free Software Foundation,
|
|
** Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
|
|
**
|
|
*/
|
|
|
|
#ifndef MU_SERVER_HH__
|
|
#define MU_SERVER_HH__
|
|
|
|
#include <memory>
|
|
#include <functional>
|
|
|
|
#include <utils/mu-sexp.hh>
|
|
#include <utils/mu-utils.hh>
|
|
#include <mu-store.hh>
|
|
|
|
/* LCOV_EXCL_START */
|
|
|
|
namespace Mu {
|
|
|
|
/**
|
|
* @brief Implements the mu server, as used by mu4e.
|
|
*/
|
|
class Server {
|
|
public:
|
|
enum struct OutputFlags {
|
|
None = 0,
|
|
Flush = 1 << 0, /**< flush output buffer after */
|
|
};
|
|
|
|
/**
|
|
* Prototype for output function
|
|
*
|
|
* @param str a string
|
|
* @param flags flags that influence the behavior
|
|
*/
|
|
using Output = std::function<void(const std::string& str, OutputFlags flags)>;
|
|
|
|
struct Options {
|
|
bool allow_temp_file; /**< temp file optimization allowed? */
|
|
};
|
|
|
|
/**
|
|
* Construct a new server
|
|
*
|
|
* @param store a message store object
|
|
* @param output callable for the server responses.
|
|
*/
|
|
Server(Store& store, const Options& opts, Output output);
|
|
|
|
/**
|
|
* DTOR
|
|
*/
|
|
~Server();
|
|
|
|
/**
|
|
* Invoke a call on the server.
|
|
*
|
|
* @param expr the s-expression to call
|
|
*
|
|
* @return true if we the server is still ready for more
|
|
* calls, false when it should quit.
|
|
*/
|
|
bool invoke(const std::string& expr) noexcept;
|
|
|
|
private:
|
|
struct Private;
|
|
std::unique_ptr<Private> priv_;
|
|
};
|
|
MU_ENABLE_BITOPS(Server::OutputFlags);
|
|
|
|
} // namespace Mu
|
|
|
|
/* LCOV_EXCL_STOP */
|
|
|
|
#endif /* MU_SERVER_HH__ */
|