1
0
Fork 0
flightgear/src/Main/globals.hxx
James Turner 9e122eaf81 Partial testing framework.
Compile a useful subset of FG as a shared library, and add two basic
uses of this to exercise some Flightplan / RoutePath / navaid
functions.

The test framework can/will be expanded incrementally from here, this
is just a starting point.
2017-03-25 15:35:26 +00:00

413 lines
12 KiB
C++

// globals.hxx -- Global state that needs to be shared among the sim modules
//
// Written by Curtis Olson, started July 2000.
//
// Copyright (C) 2000 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 _GLOBALS_HXX
#define _GLOBALS_HXX
#include <simgear/compiler.h>
#include <simgear/props/props.hxx>
#include <simgear/structure/subsystem_mgr.hxx>
#include <simgear/misc/sg_path.hxx>
#include <vector>
#include <string>
#include <memory>
typedef std::vector<std::string> string_list;
typedef std::vector<SGPath> PathList;
// Forward declarations
// This file is included, directly or indirectly, almost everywhere in
// FlightGear, so if any of its dependencies changes, most of the sim
// has to be recompiled. Using these forward declarations helps us to
// avoid including a lot of header files (and thus, a lot of
// dependencies). Since Most of the methods simply set or return
// pointers, we don't need to know anything about the class details
// anyway.
class SGCommandMgr;
class SGMaterialLib;
class SGPropertyNode;
class SGTime;
class SGEventMgr;
class SGSubsystemMgr;
class SGSubsystem;
class FGControls;
class FGTACANList;
class FGLocale;
class FGRouteMgr;
class FGScenery;
class FGViewMgr;
class FGRenderer;
namespace simgear { namespace pkg {
class Root;
}}
namespace flightgear
{
class View;
}
/**
* Bucket for subsystem pointers representing the sim's state.
*/
class FGGlobals
{
private:
// properties, destroy last
SGPropertyNode_ptr props;
// localization
FGLocale* locale;
FGRenderer *renderer;
SGSubsystemMgr *subsystem_mgr;
SGEventMgr *event_mgr;
// Number of milliseconds elapsed since the start of the program.
double sim_time_sec;
// Root of FlightGear data tree
SGPath fg_root;
/**
* locations to search for (non-scenery) data.
*/
PathList additional_data_paths;
// Users home directory for data
SGPath fg_home;
// Download directory
SGPath download_dir;
// Terrasync directory
SGPath terrasync_dir;
// Roots of FlightGear scenery tree
PathList fg_scenery;
// Paths Nasal is allowed to read
PathList extra_read_allowed_paths;
std::string browser;
// Time structure
SGTime *time_params;
#ifndef FG_TESTLIB
// Material properties library
SGSharedPtr<SGMaterialLib> matlib;
#endif
SGCommandMgr *commands;
// list of serial port-like configurations
string_list *channel_options_list;
// A list of initial waypoints that are read from the command line
// and or flight-plan file during initialization
string_list *initial_waypoints;
// Navigational Aids
FGTACANList *channellist;
/// roots of Aircraft trees
PathList fg_aircraft_dirs;
SGPath catalog_aircraft_dir;
bool haveUserSettings;
SGPropertyNode_ptr positionLon, positionLat, positionAlt;
SGPropertyNode_ptr viewLon, viewLat, viewAlt;
SGPropertyNode_ptr orientHeading, orientPitch, orientRoll;
/**
* helper to initialise standard properties on a new property tree
*/
void initProperties();
void cleanupListeners();
typedef std::vector<SGPropertyChangeListener*> SGPropertyChangeListenerVec;
SGPropertyChangeListenerVec _listeners_to_cleanup;
SGSharedPtr<simgear::pkg::Root> _packageRoot;
public:
FGGlobals();
virtual ~FGGlobals();
virtual FGRenderer *get_renderer () const;
void set_renderer(FGRenderer* render);
SGSubsystemMgr *get_subsystem_mgr () const;
SGSubsystem *get_subsystem (const char * name) const;
template<class T>
T* get_subsystem() const
{
return dynamic_cast<T*>(get_subsystem(T::subsystemName()));
}
void add_subsystem (const char * name,
SGSubsystem * subsystem,
SGSubsystemMgr::GroupType
type = SGSubsystemMgr::GENERAL,
double min_time_sec = 0);
template<class T>
T* add_new_subsystem (SGSubsystemMgr::GroupType
type = SGSubsystemMgr::GENERAL,
double min_time_sec = 0)
{
T* sub = new T;
add_subsystem(T::subsystemName(), sub, type, min_time_sec);
return sub;
}
SGEventMgr *get_event_mgr () const;
inline double get_sim_time_sec () const { return sim_time_sec; }
inline void inc_sim_time_sec (double dt) { sim_time_sec += dt; }
inline void set_sim_time_sec (double t) { sim_time_sec = t; }
const SGPath &get_fg_root () const { return fg_root; }
void set_fg_root (const SGPath&root);
/**
* Get list of data locations. fg_root is always the final item in the
* result.
*/
PathList get_data_paths() const;
/**
* Get data locations which contain the file path suffix. Eg pass ing
* 'AI/Traffic' to get all data paths which define <path>/AI/Traffic subdir
*/
PathList get_data_paths(const std::string& suffix) const;
void append_data_path(const SGPath& path);
/**
* Given a path suffix (eg 'Textures' or 'AI/Traffic'), find the
* first data directory which defines it.
*/
SGPath find_data_dir(const std::string& pathSuffix) const;
const SGPath &get_fg_home () const { return fg_home; }
void set_fg_home (const SGPath &home);
const SGPath &get_download_dir () const { return download_dir; }
// The 'path' argument to set_download_dir() must come from trustworthy
// code, because the method grants read permissions to Nasal code for many
// files beneath 'path'. In particular, don't call this method with a
// 'path' value taken from the property tree or any other Nasal-writable
// place.
void set_download_dir (const SGPath &path);
const SGPath &get_terrasync_dir () const { return terrasync_dir; }
// The 'path' argument to set_terrasync_dir() must come from trustworthy
// code, because the method grants read permissions to Nasal code for all
// files beneath 'path'. In particular, don't call this method with a
// 'path' value taken from the property tree or any other Nasal-writable
// place.
void set_terrasync_dir (const SGPath &path);
const PathList &get_fg_scenery () const { return fg_scenery; }
const PathList &get_extra_read_allowed_paths () const { return extra_read_allowed_paths; }
/**
* Add a scenery directory
*
* This also makes the path Nasal-readable:
* to avoid can-read-any-file security holes, do NOT call this on paths
* obtained from the property tree or other Nasal-writable places
*/
void append_fg_scenery (const SGPath &scenery);
void append_fg_scenery (const PathList &scenery);
void clear_fg_scenery();
/**
* Allow Nasal to read a path
*
* To avoid can-read-any-file security holes, do NOT call this on paths
* obtained from the property tree or other Nasal-writable places
*
* Only works during initial load (before fgInitAllowedPaths)
*/
void append_read_allowed_paths (const SGPath &path);
/**
* specify a path we'll prepend to the aircraft paths list if non-empty.
* This is used with packaged aircraft, to ensure their catalog (and hence,
* dependency packages) are found correctly.
*/
void set_catalog_aircraft_path(const SGPath& path);
PathList get_aircraft_paths() const;
/**
* Add an aircraft directory
*
* This also makes the path Nasal-readable:
* to avoid can-read-any-file security holes, do NOT call this on paths
* obtained from the property tree or other Nasal-writable places
*/
void append_aircraft_path(const SGPath& path);
void append_aircraft_paths(const PathList& path);
/**
* Given a path to an aircraft-related resource file, resolve it
* against the appropriate root. This means looking at the location
* defined by /sim/aircraft-dir, and then aircraft_path in turn,
* finishing with fg_root/Aircraft.
*
* if the path could not be resolved, an empty path is returned.
*/
SGPath resolve_aircraft_path(const std::string& branch) const;
/**
* Same as above, but test for non 'Aircraft/' branch paths, and
* always resolve them against fg_root.
*/
SGPath resolve_maybe_aircraft_path(const std::string& branch) const;
/**
* Search in the following directories:
*
* 1. Root directory of current aircraft (defined by /sim/aircraft-dir)
* 2. All aircraft directories if branch starts with Aircraft/
* 3. fg_data directory
*/
SGPath resolve_resource_path(const std::string& branch) const;
inline const std::string &get_browser () const { return browser; }
void set_browser (const std::string &b) { browser = b; }
long int get_warp() const;
void set_warp( long int w );
long int get_warp_delta() const;
void set_warp_delta( long int d );
inline SGTime *get_time_params() const { return time_params; }
inline void set_time_params( SGTime *t ) { time_params = t; }
inline SGMaterialLib *get_matlib() const
{
#ifdef FG_TESTLIB
return nullptr;
#else
return matlib;
#endif
}
void set_matlib( SGMaterialLib *m );
inline SGPropertyNode *get_props () { return props; }
/**
* @brief reset the property tree to new, empty tree. Ensure all
* subsystems are shutdown and unbound before call this.
*/
void resetPropertyRoot();
inline FGLocale* get_locale () { return locale; }
inline SGCommandMgr *get_commands () { return commands; }
SGGeod get_aircraft_position() const;
SGVec3d get_aircraft_position_cart() const;
void get_aircraft_orientation(double& heading, double& pitch, double& roll);
SGGeod get_view_position() const;
SGVec3d get_view_position_cart() const;
inline string_list *get_channel_options_list () {
return channel_options_list;
}
inline void set_channel_options_list( string_list *l ) {
channel_options_list = l;
}
inline string_list *get_initial_waypoints () {
return initial_waypoints;
}
inline void set_initial_waypoints (string_list *list) {
initial_waypoints = list;
}
FGViewMgr *get_viewmgr() const;
flightgear::View *get_current_view() const;
FGControls *get_controls() const;
FGScenery * get_scenery () const;
inline FGTACANList *get_channellist() const { return channellist; }
inline void set_channellist( FGTACANList *c ) { channellist = c; }
/**
* Return an SGPath instance for the autosave file under 'userDataPath',
* which defaults to $FG_HOME.
*/
SGPath autosaveFilePath(SGPath userDataPath = SGPath()) const;
/**
* Load user settings from the autosave file under 'userDataPath',
* which defaults to $FG_HOME.
*/
void loadUserSettings(SGPath userDatapath = SGPath());
/**
* Save user settings to the autosave file under 'userDataPath', which
* defaults to $FG_HOME.
*
* When calling this method, make sure the value of 'userDataPath' is
* trustworthy. In particular, make sure it can't be influenced by Nasal
* code, not even indirectly via a Nasal-writable place such as the
* property tree.
*
* Note: the default value is safe---if not, it would be a bug.
*/
void saveUserSettings(SGPath userDatapath = SGPath());
void addListenerToCleanup(SGPropertyChangeListener* l);
simgear::pkg::Root* packageRoot();
void setPackageRoot(const SGSharedPtr<simgear::pkg::Root>& p);
};
extern FGGlobals *globals;
#endif // _GLOBALS_HXX