blob: 6a18466981276ba0c22972b9d1dc1598a09b331f (
plain) (
blame)
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
|
/*
* key.hh - Definition of the base Key class
* libhscript, the HorizonScript library for
* Project Horizon
*
* Copyright (c) 2019 Adélie Linux and contributors. All rights reserved.
* This code is licensed under the AGPL 3.0 license, as noted in the
* LICENSE-code file in the root directory of this repository.
*
* SPDX-License-Identifier: AGPL-3.0-only
*/
#ifndef __HSCRIPT_KEY_HH_
#define __HSCRIPT_KEY_HH_
#include <string>
namespace Horizon {
namespace Keys {
/*! Base Key class, used by all Keys.
* A Getter method is not provided in this base Key class, because each Key may
* return a different type of data. For example, `network` may return `bool`.
*/
class Key {
public:
virtual ~Key();
/*! Create the Key object with the specified data as the entire value.
* @returns nullptr if data is unparsable, otherwise a pointer to a Key.
*/
static Key *parseFromData(std::string) { return nullptr; }
/*! Determines if the data associated with the Key is valid. */
virtual bool validate() = 0;
/*! Executes the action associated with this Key.
* @note Will always return `false` if `validate` is `false`.
*/
virtual bool execute() = 0;
};
}
}
#endif
|
