//
// fg_init.hxx -- Flight Gear top level initialization routines
//
// Written by Curtis Olson, started August 1997.
//
// Copyright (C) 1997  Curtis L. Olson  - http://www.flightgear.org/~curt
//
// This program 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 2 of the
// License, or (at your option) any later version.
//
// 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 General Public License
// along with this program; if not, write to the Free Software
// Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
//
// $Id$


#ifndef _FG_INIT_HXX
#define _FG_INIT_HXX

#include <string>
#include <optional>

#include <simgear/misc/sg_path.hxx>

// forward decls
class SGPropertyNode;
class SGPath;

// Return the current base package version
std::string fgBasePackageVersion(const SGPath& path);

/**
 * @brief structure holding parsed info from <base-package>/base_package.json
 * 
 */
struct FGBasePackageInfo {
    std::string version;
    std::string suffix;
    std::string buildDate;
    std::string gitRevision;
};

/**
 * @brief Parse the base package info JSON
 * 
 * @param path 
 * @return std::optional<FGBasePackageInfo> 
 */
std::optional<FGBasePackageInfo>
fgBasePackageInfo(const SGPath& path);

SGPath fgHomePath();

enum InitHomeResult
{
    InitHomeOkay,
    InitHomeReadOnly,
    InitHomeExplicitReadOnly,
    InitHomeAbort
};

InitHomeResult fgInitHome(int argc, char** argv);
void fgShutdownHome();
void fgDeleteLockFile();

// Read in configuration (file and command line)
int fgInitConfig ( int argc, char **argv, bool reinit );

void fgInitAircraftPaths(bool reinit);

/**
 * @brief 
 * 
 * @param reinit : is this a second(+) call of the function, i.e after reset
 * @param didUseLauncher : allow adjusting UI feedback if we used the launcher or not
 * @return int : an Options result to indicate if we should continue, quit, etc
 */
int fgInitAircraft(bool reinit, bool didUseLauncher);

// log various settings / configuration state
void fgOutputSettings();

// Initialize the localization
SGPropertyNode *fgInitLocale(const char *language);

// Init navaids and waypoints
bool fgInitNav ();


// General house keeping initializations
bool fgInitGeneral ();


// Create all the subsystems needed by the sim
void fgCreateSubsystems(bool duringReset);

// called after the subsystems have been bound and initialised,
// to peform final init
void fgPostInitSubsystems();

// Re-position: when only location is changing, we can do considerably
// less work than a full re-init.
void fgStartReposition();

void fgStartNewReset();

// setup the package system including the global root
void fgInitPackageRoot();

// wipe FG_HOME. (The removing of the program data is assumed to be done
// by the real installer).
int fgUninstall();

#endif // _FG_INIT_HXX



