path: root/hscript/script.hh

/*
 * 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:
    /*! Initialise the Script class. */
    Script();

    /*! Load a HorizonScript from the specified path.
     * @param path      The path to load from.
     * @return true if the Script could be loaded; false otherwise.
     */
    bool load(std::string path);
    /*! Load a HorizonScript from the specified stream.
     * @param stream    The stream to load from.
     * @return true if the Script could be loaded; false otherwise.
     */
    bool load(std::istream &stream);

    /*! Parses the HorizonScript. */
    bool parse();
    /*! Determines if the HorizonScript is valid. */
    bool validate();

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

}