RuneOptimizer/src/cli/runeoptimizer/gui/gui.h

/*
 * This file is part of RuneOptimizer.
 *
 * RuneOptimizer is free software: you can redistribute it and/or modify it
 * under the terms of the GNU General Public License as published by the Free
 * Software Foundation, either version 3 of the License, or (at your option)
 * any later version.
 *
 * RuneOptimizer 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 General Public License along with
 * RuneOptimizer. If not, see <https://www.gnu.org/licenses/>.
 */

/**
 * @file gui.h
 *
 * Declarations of the functions related to the gui command.
 *
 * This file declares all the functions used by the gui command implemented in
 * {@link gui.c}.
 */

#pragma once

/**
 * Makes sure that the database is set up for the gui.
 *
 * This will make sure that the database exists in the default location, and
 * that all the tables are created by making a call to {@link db_open}.
 *
 * @return {@link SUCCESS} or {@link ERROR_DB_CANT_OPEN} if the database
 * can't be created or accessed.
 */
int gui();