bpf::system::Application class
#include <Base/include/Framework/System/Application.hpp>

Contents

Class to represent the running application

Derived classes

class UnixApp final
class WindowsApp final

Constructors, destructors, conversion operators

Application(collection::HashMap<String, String>& env, String& fileName, Paths& props)
~Application() virtual

Public functions

void CreateConsole(fint rows = 32, fint columns = 80) pure virtual
auto GetWorkingDirectory() const -> io::File pure virtual
auto SetWorkingDirectory(const io::File& file) -> bool pure virtual
void DisableErrorDialogs() pure virtual noexcept
void SetModuleDirectories(const collection::Array<io::File>& directories) pure virtual

Public variables

const collection::HashMap<String, String>& Environment
const String& FileName
const Paths& Props

Function documentation

bpf::system::Application::Application(collection::HashMap<String, String>& env, String& fileName, Paths& props)

Parameters
env the environment map reference
fileName the application's file name reference
props the application's paths properties reference

Constructs an Application container

void bpf::system::Application::CreateConsole(fint rows = 32, fint columns = 80) pure virtual

Parameters
rows number of rows in the console window
columns number of columns in the console window
Exceptions
OSException in case of system error

Allocates a console for this application if it does not already have one. Only useful when the system do not create a console

io::File bpf::system::Application::GetWorkingDirectory() const pure virtual

Returns new io::File containing current working directory as given by system

Gets the current working directory

bool bpf::system::Application::SetWorkingDirectory(const io::File& file) pure virtual

Parameters
file the new current working directory (relative paths are supported)
Returns true if operation succeeded, false otherwise

Sets the current working directory

void bpf::system::Application::DisableErrorDialogs() pure virtual noexcept

Disables operating system level dialogs shown when an application crashes. Useful when building command line applications

void bpf::system::Application::SetModuleDirectories(const collection::Array<io::File>& directories) pure virtual

Parameters
directories the new directories to use for resolving dependencies
Exceptions
OSException if multiple directories are given and the system only supports one or if system error
io::IOException if any of the given paths is not a directory

Sets the additional module directories for this application

Variable documentation

const collection::HashMap<String, String>& bpf::system::Application::Environment

The environment of the application

const String& bpf::system::Application::FileName

The executable file name

const Paths& bpf::system::Application::Props

Application's paths properties