SdlPref Class Reference

#include <sdl_prefs.hpp>

Public Member Functions
std::string	get_pref_file ()
std::string	get_string (const std::string &key, const std::string &fallback="")
int64_t	get_int (const std::string &key, int64_t fallback=0)
bool	get_bool (const std::string &key, bool fallback=false)
std::vector< std::string >	get_array (const std::string &key, const std::vector< std::string > &fallback={})

Static Public Member Functions
static std::shared_ptr< SdlPref >	instance (const std::string &name=SdlPref::get_default_file())
static void	print_config_file_help (int version)

Detailed Description

FreeRDP: A Remote Desktop Protocol Implementation SDL Prefs

Copyright 2022 Armin Novak armin.nosp@m..nov.nosp@m.ak@th.nosp@m.inca.nosp@m.st.co.nosp@m.m

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Definition at line 27 of file sdl_prefs.hpp.

Member Function Documentation

get_array()

std::vector< std::string > SdlPref::get_array	(	const std::string &	key,
		const std::vector< std::string > &	fallback = {}
	)

Definition at line 87 of file sdl_prefs.cpp.

{
  auto item = get_item(key);
  if (!item || !WINPR_JSON_IsArray(item))
    return fallback;
 
  std::vector<std::string> values;
  for (size_t x = 0; x < WINPR_JSON_GetArraySize(item); x++)
  {
    auto cur = WINPR_JSON_GetArrayItem(item, x);
    values.push_back(item_to_str(cur));
  }
 
  return values;
}

get_bool()

bool SdlPref::get_bool	(	const std::string &	key,
		bool	fallback = false
	)

Definition at line 70 of file sdl_prefs.cpp.

{
  auto item = get_item(key);
  if (!item || !WINPR_JSON_IsBool(item))
    return fallback;
  return WINPR_JSON_IsTrue(item);
}

get_int()

int64_t SdlPref::get_int	(	const std::string &	key,
		int64_t	fallback = 0
	)

Definition at line 78 of file sdl_prefs.cpp.

{
  auto item = get_item(key);
  if (!item || !WINPR_JSON_IsNumber(item))
    return fallback;
  auto val = WINPR_JSON_GetNumberValue(item);
  return static_cast<int64_t>(val);
}

get_pref_file()

std::string SdlPref::get_pref_file

(

)

Definition at line 193 of file sdl_prefs.cpp.

{
  return _name;
}

get_string()

std::string SdlPref::get_string	(	const std::string &	key,
		const std::string &	fallback = ""
	)

Definition at line 64 of file sdl_prefs.cpp.

{
  auto item = get_item(key);
  return item_to_str(item, fallback);
}

instance()

std::shared_ptr< SdlPref > SdlPref::instance ( const std::string &  name = SdlPref::get_default_file() )

static

Definition at line 185 of file sdl_prefs.cpp.

{
  static std::shared_ptr<SdlPref> _instance;
  if (!_instance || (_instance->get_pref_file() != name))
    _instance.reset(new SdlPref(name));
  return _instance;
}

print_config_file_help()

void SdlPref::print_config_file_help ( int  version )

static

Definition at line 104 of file sdl_prefs.cpp.

{
#if defined(WITH_WINPR_JSON)
  const std::string url = "https://wiki.libsdl.org/SDL" + std::to_string(version);
  std::cout << "CONFIGURATION FILE" << std::endl;
  std::cout << std::endl;
  std::cout << "  The SDL client supports some user defined configuration options." << std::endl;
  std::cout << "  Settings are stored in JSON format" << std::endl;
  std::cout << "  The location is a per user file. Location for current user is "
            << SdlPref::instance()->get_pref_file() << std::endl;
  std::cout
      << "  The XDG_CONFIG_HOME environment variable can be used to override the base directory."
      << std::endl;
  std::cout << std::endl;
  std::cout << "  The following configuration options are supported:" << std::endl;
  std::cout << std::endl;
  std::cout << "    SDL_KeyModMask" << std::endl;
  std::cout << "      Defines the key combination required for SDL client shortcuts."
            << std::endl;
  std::cout << "      Default KMOD_RSHIFT" << std::endl;
  std::cout << "      An array of SDL_Keymod strings as defined at "
               ""
            << url << "/SDL_Keymod" << std::endl;
  std::cout << std::endl;
  std::cout << "    SDL_Fullscreen" << std::endl;
  std::cout << "      Toggles client fullscreen state." << std::endl;
  std::cout << "      Default SDL_SCANCODE_RETURN." << std::endl;
  std::cout << "      A string as "
               "defined at "
            << url << "/SDLScancodeLookup" << std::endl;
  std::cout << std::endl;
  std::cout << "    SDL_Minimize" << std::endl;
  std::cout << "      Minimizes client windows." << std::endl;
  std::cout << "      Default SDL_SCANCODE_M." << std::endl;
  std::cout << "      A string as "
               "defined at "
            << url << "/SDLScancodeLookup" << std::endl;
  std::cout << std::endl;
  std::cout << "    SDL_Resizeable" << std::endl;
  std::cout << "      Toggles local window resizeable state." << std::endl;
  std::cout << "      Default SDL_SCANCODE_R." << std::endl;
  std::cout << "      A string as "
               "defined at "
            << url << "/SDLScancodeLookup" << std::endl;
  std::cout << std::endl;
  std::cout << "    SDL_Grab" << std::endl;
  std::cout << "      Toggles keyboard and mouse grab state." << std::endl;
  std::cout << "      Default SDL_SCANCODE_G." << std::endl;
  std::cout << "      A string as "
               "defined at "
            << url << "/SDLScancodeLookup" << std::endl;
  std::cout << std::endl;
  std::cout << "    SDL_Disconnect" << std::endl;
  std::cout << "      Disconnects from the RDP session." << std::endl;
  std::cout << "      Default SDL_SCANCODE_D." << std::endl;
  std::cout << "      A string as defined at " << url << "/SDLScancodeLookup" << std::endl;
#endif
}

---

The documentation for this class was generated from the following files:

• sdl_prefs.hpp
• sdl_prefs.cpp