opencog-atomspace / opencog / atoms / foreign / SexprAST.h

/*
 * opencog/atoms/foreign/SexprAST.h
 *
 * Copyright (C) 2021 Linas Vepstas
 * All Rights Reserved
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU Affero General Public License v3 as
 * published by the Free Software Foundation and including the exceptions
 * at http://opencog.org/wiki/Licenses
 *
 * 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 Affero General Public License
 * along with this program; if not, write to:
 * Free Software Foundation, Inc.,
 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 */

#ifndef _OPENCOG_SEXPR_AST_H
#define _OPENCOG_SEXPR_AST_H

#include <opencog/atoms/foreign/ForeignAST.h>

namespace opencog
{
/** \addtogroup grp_atomspace
 *  @{
 */

/// The SexprAST holds generic abstract syntax trees, printed as
/// s-expressions.
///
class SexprAST : public ForeignAST
{
	void init();

	static Handle get_next_expr(const std::string&, size_t& l, size_t& r);

protected:
	void parse(const std::string&);
	virtual Handle next_expr(const std::string&, size_t& l, size_t& r);

public:
	SexprAST(Type);
	SexprAST(const HandleSeq&&, Type = SEXPR_AST);
	SexprAST(const SexprAST&) = delete;
	SexprAST& operator=(const SexprAST&) = delete;

	SexprAST(const std::string&);

	virtual std::string to_string(const std::string& indent) const;
	virtual std::string to_short_string(const std::string& indent) const;

	static Handle factory(const Handle&);
};

LINK_PTR_DECL(SexprAST)
#define createSexprAST CREATE_DECL(SexprAST)

/** @}*/
}

#endif // _OPENCOG_SEXPR_AST_H