opencog-atomspace / opencog / atoms / grounded / LibraryRunner.cc

/*
 * opencog/atoms/grounded/LibraryRunner.cc
 *
 * Copyright (C) 2009, 2013, 2014, 2015, 2020 Linas Vepstas
 * SPDX-License-Identifier: AGPL-3.0-or-later
 * 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.
 */

#include <opencog/atoms/atom_types/atom_types.h>
#include <opencog/atoms/value/Value.h>
#include <opencog/atomspace/AtomSpace.h>

#include <opencog/atoms/grounded/LibraryManager.h>
#include <opencog/atoms/grounded/LibraryRunner.h>

using namespace opencog;

LibraryRunner::LibraryRunner(std::string s)
	: _fname(s)
{
	// Extract the language, library and function from schema
	std::string lang, lib, fun;
	LibraryManager::parse_schema(_fname, lang, lib, fun);

	sym = LibraryManager::getFunc(lib,fun);
}

// ----------------------------------------------------------

/// `execute()` -- evaluate a LibraryRunner with arguments.
/// Execution happens in the provided scratch space.
///
/// Expects "args" to be a ListLink. These arguments will be
///     substituted into the predicate.
///
ValuePtr LibraryRunner::execute(AtomSpace* scratch,
                                const ValuePtr& vargs,
                                bool silent)
{
	if (not vargs->is_atom())
		throw SyntaxException(TRACE_INFO,
			"LibraryRunner: Expecting Handle; got %s",
			vargs->to_string().c_str());

	Handle cargs = HandleCast(vargs);
	Handle args(scratch->add_atom(cargs));

	// Convert the void* pointer to the correct function type.
	// Functions can return either Handle* or ValuePtr*.
	// Try ValuePtr* first, as it's more general.
	ValuePtr* (*func)(AtomSpace*, Handle*);
	func = reinterpret_cast<ValuePtr* (*)(AtomSpace *, Handle*)>(sym);

	ValuePtr result;

	// Execute the function
	ValuePtr* res = func(scratch, &args);
	if (nullptr != res)
	{
		result = *res;
		delete res;
	}

	if (nullptr == result)
		throw SyntaxException(TRACE_INFO,
	        "Invalid return value from grounded schema %s\nArgs: %s",
		        _fname.c_str(),
		        cargs->to_short_string().c_str());

	return result;
}