blob: 1b62615bacb9fac46183dcca18dbffe8f17af818 (
plain)
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
75
|
/*
** Copyright (C) 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_QUERY_MACROS_HH__
#define MU_QUERY_MACROS_HH__
#include <string>
#include <memory>
#include <utils/mu-result.hh>
#include <utils/mu-option.hh>
#include "mu-config.hh"
namespace Mu {
class QueryMacros{
public:
/**
* Construct QueryMacros object
*
* @param conf config object ref
*/
QueryMacros(const Config& conf);
/**
* DTOR
*/
~QueryMacros();
/**
* Read bookmarks (ie. macros) from a bookmark-file
*
* @param bookmarks_file path to the bookmarks file
*
* @return Ok or some error
*/
Result<void> load_bookmarks(const std::string& bookmarks_file);
/**
* Find a macro (aka 'bookmark') by its name
*
* @param name the name of the bookmark
*
* @return the macro value or Nothing if not found
*/
Option<std::string> find_macro(const std::string& name) const;
private:
struct Private;
std::unique_ptr<Private> priv_;
};
} // namespace Mu
#endif /* MU_QUERY_MACROS_HH__ */
|
