summaryrefslogtreecommitdiff
path: root/hscript/script.hh
blob: 98f79afd34fa9f9701f79905f49d616564f08549 (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
/*
 * script.hh - Definition of the Script 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
 */

#include <string>
#include <vector>
#include <memory>

namespace Horizon {

/*! Defines the Script class, which represents a HorizonScript. */
class Script {
public:
    /*! Load a HorizonScript from the specified path and attempt to parse. */
    Script(std::string path);
    /*! Load a HorizonScript from the specified stream and attempt to parse. */
    Script(std::istream &stream);

    /*! Determines if the HorizonScript parsed correctly. */
    bool isParsed();
    /*! Determines if the HorizonScript is valid. */
    bool isValid();

    /*! Returns a list of errors found while parsing and validating the script. */
    std::vector<std::string> scriptErrors();

private:
    struct ScriptPrivate;
    /*! Internal data. */
    const std::unique_ptr<ScriptPrivate> internal;
};

}