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
|
/*
** Copyright (C) 2022 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_SCRIPT_HH__
#define MU_SCRIPT_HH__
#include <string>
#include <vector>
#include <utils/mu-result.hh>
namespace Mu {
/**
* Information about a script.
*
*/
struct ScriptInfo {
std::string name; /**< Name of script */
std::string path; /**< Full path to script */
std::string oneline; /**< One-line description */
std::string description; /**< More help */
};
/// Sequence of script infos.
using ScriptInfos = std::vector<ScriptInfo>;
/**
* Get information about the available scripts
*
* @return infos
*/
using ScriptPaths = std::vector<std::string>;
ScriptInfos script_infos(const ScriptPaths& paths);
/**
* Run some specific script
*
* @param path full path to the scripts
* @param args argument vector to pass to the script
*
* @return Ok() or some error; however, note that this does not return after succesfully
* starting a script.
*/
Result<void> run_script(const std::string& path, const std::vector<std::string>& args);
} // namepace Mu
#endif /* MU_SCRIPT_HH__ */
|
