The Battle for Wesnoth  1.19.0-dev
game_cache_options.cpp
Go to the documentation of this file.
1 /*
2  Copyright (C) 2014 - 2024
3  by Iris Morelle <shadowm2006@gmail.com>
4  Part of the Battle for Wesnoth Project https://www.wesnoth.org/
5 
6  This program is free software; you can redistribute it and/or modify
7  it under the terms of the GNU General Public License as published by
8  the Free Software Foundation; either version 2 of the License, or
9  (at your option) any later version.
10  This program is distributed in the hope that it will be useful,
11  but WITHOUT ANY WARRANTY.
12 
13  See the COPYING file for more details.
14 */
15 
16 #define GETTEXT_DOMAIN "wesnoth-lib"
17 
19 
20 #include "desktop/clipboard.hpp"
21 #include "config_cache.hpp"
22 #include "cursor.hpp"
23 #include "desktop/open.hpp"
24 #include "filesystem.hpp"
26 #include "gui/dialogs/message.hpp"
27 #include "gui/widgets/button.hpp"
28 #include "gui/widgets/label.hpp"
29 #include "gui/widgets/text_box.hpp"
30 #include "gui/widgets/window.hpp"
31 
32 #include <functional>
33 
34 #include "gettext.hpp"
35 
36 namespace gui2::dialogs
37 {
38 
39 REGISTER_DIALOG(game_cache_options)
40 
42  : modal_dialog(window_id())
43  , cache_path_(filesystem::get_cache_dir())
44  , clean_button_(nullptr)
45  , purge_button_(nullptr)
46  , size_label_(nullptr)
47 {
48 }
49 
51 {
52  clean_button_ = find_widget<button>(&window, "clean", false, true);
53  purge_button_ = find_widget<button>(&window, "purge", false, true);
54  size_label_ = find_widget<label>(&window, "size", false, true);
55 
57 
58  text_box_base& path_box = find_widget<text_box_base>(&window, "path", false);
59  path_box.set_value(cache_path_);
60  path_box.set_active(false);
61 
62  button& copy = find_widget<button>(&window, "copy", false);
65  this));
67  copy.set_active(false);
68  copy.set_tooltip(_("Clipboard support not found, contact your packager"));
69  }
70 
71  button& browse = find_widget<button>(&window, "browse", false);
74  this));
75 
78  this));
79 
82  this));
83 }
84 
86 {
87  size_label_ = nullptr;
88 }
89 
91 {
92  if(!size_label_) {
93  return;
94  }
95 
96  const cursor::setter cs(cursor::WAIT);
98 
99  if(size < 0) {
100  size_label_->set_label(_("dir_size^Unknown"));
101  } else {
102  size_label_->set_label(utils::si_string(size, true, _("unit_byte^B")));
103  }
104 
105  if(size == 0) {
106  clean_button_->set_active(false);
107  purge_button_->set_active(false);
108  }
109 }
110 
112 {
114 }
115 
117 {
119 }
120 
122 {
123  if(clean_cache()) {
124  show_message(
125  _("Cache Cleaned"),
126  _("The game data cache has been cleaned."));
127  } else {
128  show_error_message(_("The game data cache could not be completely cleaned."));
129  }
130 
132 }
133 
135 {
136  const cursor::setter cs(cursor::WAIT);
138 }
139 
141 {
142  if(purge_cache()) {
143  show_message(
144  _("Cache Purged"),
145  _("The game data cache has been purged."));
146  } else {
147  show_error_message(_("The game data cache could not be purged."));
148  }
149 
151 }
152 
154 {
155  const cursor::setter cs(cursor::WAIT);
157 }
158 
159 } // namespace dialogs
bool purge_cache()
Deletes all cache files.
static config_cache & instance()
Get reference to the singleton object.
bool clean_cache()
Deletes stale cache files not in use by the game.
Simple push button.
Definition: button.hpp:36
virtual void set_active(const bool active) override
See styled_widget::set_active.
Definition: button.cpp:63
A Preferences subdialog including a report on the location and size of the game's WML cache,...
virtual void post_show(window &window) override
Actions to be taken after the window has been shown.
std::string cache_path_
The display function.
virtual void pre_show(window &window) override
Actions to be taken before showing the window.
Abstract base class for all modal dialogs.
void set_tooltip(const t_string &tooltip)
virtual void set_label(const t_string &text)
Abstract base class for text items.
virtual void set_value(const std::string &text)
The set_value is virtual for the password_box class.
virtual void set_active(const bool active) override
See styled_widget::set_active.
base class of top level items, the only item which needs to store the final canvases to draw on.
Definition: window.hpp:63
Declarations for File-IO.
static std::string _(const char *str)
Definition: gettext.hpp:93
This file contains the window object, this object is a top level container which has the event manage...
@ WAIT
Definition: cursor.hpp:28
void copy_to_clipboard(const std::string &text, const bool)
Copies text to the clipboard.
Definition: clipboard.cpp:32
bool available()
Whether wesnoth was compiled with support for a clipboard.
Definition: clipboard.cpp:53
bool open_object([[maybe_unused]] const std::string &path_or_url)
Definition: open.cpp:46
std::string get_cache_dir()
Definition: filesystem.cpp:880
int dir_size(const std::string &pname)
Returns the sum of the sizes of the files contained in a directory.
REGISTER_DIALOG(tod_new_schedule)
void connect_signal_mouse_left_click(dispatcher &dispatcher, const signal &signal)
Connects a signal handler for a left mouse button click.
Definition: dispatcher.cpp:177
void show_error_message(const std::string &msg, bool message_use_markup)
Shows an error message to the user.
Definition: message.cpp:203
void show_message(const std::string &title, const std::string &msg, const std::string &button_caption, const bool auto_close, const bool message_use_markup, const bool title_use_markup)
Shows a message to the user.
Definition: message.cpp:150
std::size_t size(const std::string &str)
Length in characters of a UTF-8 string.
Definition: unicode.cpp:85
std::string si_string(double input, bool base2, const std::string &unit)
Convert into a string with an SI-postfix.
Desktop environment interaction functions.