File: AudioComDialogBase.cpp

package info (click to toggle)
audacity 3.7.3%2Bdfsg-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 125,252 kB
  • sloc: cpp: 358,238; ansic: 75,458; lisp: 7,761; sh: 3,410; python: 1,503; xml: 1,385; perl: 854; makefile: 122
file content (281 lines) | stat: -rw-r--r-- 6,772 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
/*  SPDX-License-Identifier: GPL-2.0-or-later */
/*!********************************************************************

  Audacity: A Digital Audio Editor

  AudioComDialogBase.cpp

  Dmitry Vedenko

**********************************************************************/
#include "AudioComDialogBase.h"

#include <cassert>
#include <list>

#include <wx/button.h>
#include <wx/checkbox.h>
#include <wx/sizer.h>
#include <wx/statline.h>
#include <wx/stattext.h>

#include "AccessibilityUtils.h"
#include "Prefs.h"
#include "Project.h"
#include "ProjectWindow.h"

#include "AccessibleLinksFormatter.h"
#include "ShuttleGui.h"

#include "AppEvents.h"
#include "Observer.h"

namespace audacity::cloud::audiocom::sync
{
namespace
{
wxWindow* GetProjectWindow(const AudacityProject* project)
{
   if (project == nullptr)
      return nullptr;

   return &ProjectWindow::Get(*const_cast<AudacityProject*>(project));
}

wxString GetOptionalPrefsIdentifier(const DialogIdentifier& identifier)
{
   if (identifier.empty())
      return {};

   return wxString::Format("/cloud/audiocom/%s/skip", identifier.GET());
}
} // namespace

DialogButtonIdentifier
audacity::cloud::audiocom::sync::AudioComDialogBase::ShowDialog(
   std::function<DialogButtonIdentifier()> poller)
{
   mDialogSizer->AddStretchSpacer(1);

   if (HasSeparator())
   {
      mDialogSizer->Add(
         safenew wxStaticLine { this },
         wxSizerFlags {}.Border(wxTOP, 16).Expand());
      mDialogSizer->AddSpacer(8);
   }
   else
      mDialogSizer->AddSpacer(16);

   mDialogSizer->Add(
      mButtonSizer, wxSizerFlags {}.Border(wxLEFT | wxRIGHT, 16).Expand());
   mDialogSizer->AddSpacer(8);

   SetSizerAndFit(mDialogSizer);
   SetupAccessibility(this);
   Center();

   // We cannot do it earlier to avoid licking the sizers and children
   if (!mOptionalPrefsIdentifier.empty())
   {
      if (gPrefs->ReadBool(mOptionalPrefsIdentifier.GET(), false))
         return mEscButtonIdentifier;
   }

   Show();
   Raise();

   {
      wxWindowDisabler disabler { this };

      if (!poller)
         poller = [] { return DialogButtonIdentifier {}; };

      while (IsShown())
      {
         wxYield();

         if (auto result = poller(); !result.empty())
            return result;
      }
   }

   // On Windows, parent window will lose focus after the wxWindowDisabler is destroyed
   if (auto parent = GetParent())
      parent->Raise();

   // mResultButtonIdentifier is empty if the dialog was closed using the
   // cross button
   return mResultButtonIdentifier.empty() ? mEscButtonIdentifier :
                                            mResultButtonIdentifier;
}

DialogButtonIdentifier AudioComDialogBase::CancelButtonIdentifier()
{
   return { L"Cancel" };
}

AudioComDialogBase::AudioComDialogBase(
   const AudacityProject* project,
   const DialogIdentifier& optionalPrefsIdentifier, DialogMode dialogMode)
    : wxDialogWrapper { GetProjectWindow(project), wxID_ANY,
                        dialogMode == DialogMode::Saving ?
                           XO("Save to audio.com") :
                           XO("Open from audio.com") }
    , mProject { project }
    , mOptionalPrefsIdentifier { GetOptionalPrefsIdentifier(
         optionalPrefsIdentifier) }
    , mDialogSizer { new wxBoxSizer(wxVERTICAL) }
    , mButtonSizer { new wxBoxSizer(wxHORIZONTAL) }
{
   mDialogSizer->SetMinSize({ 420, 140 });
   if (!mOptionalPrefsIdentifier.empty())
   {
      const auto skipDialog =
         gPrefs->ReadBool(mOptionalPrefsIdentifier.GET(), false);

      auto checkbox =
         safenew wxCheckBox { this, wxID_ANY,
                              XO("Don't show this again").Translation() };

      checkbox->SetValue(skipDialog);

      mButtonSizer->Add(checkbox, wxSizerFlags {}.CenterVertical());

      checkbox->Bind(
         wxEVT_CHECKBOX,
         [this, checkbox](auto&)
         {
            gPrefs->Write(mOptionalPrefsIdentifier.GET(), checkbox->GetValue());
            gPrefs->Flush();
         });
   }

   mButtonSizer->AddStretchSpacer();

   Bind(
      wxEVT_CHAR_HOOK,
      [this](auto& evt)
      {
         if (!IsEscapeKey(evt))
         {
            evt.Skip();
            return;
         }

         EndDialog(mEscButtonIdentifier);
      });
}

void AudioComDialogBase::AddTitle(const TranslatableString& title)
{
   auto font = GetFont().Bold();

   font.SetFractionalPointSize(font.GetFractionalPointSize() * 1.5f);

   auto statText = safenew wxStaticText { this, wxID_ANY, title.Translation() };

   statText->SetFont(font);

   mDialogSizer->AddSpacer(16);
   mDialogSizer->Add(statText, wxSizerFlags {}.Border(wxLEFT | wxRIGHT, 16));
}

void AudioComDialogBase::AddParagraph(const TranslatableString& paragraph)
{
   auto statText =
      safenew wxStaticText { this, wxID_ANY, paragraph.Translation() };

   mDialogSizer->AddSpacer(16);
   mDialogSizer->Add(statText, wxSizerFlags {}.Border(wxLEFT | wxRIGHT, 16));

   statText->Wrap(400);
}

void AudioComDialogBase::AddButton(
   DialogButtonIdentifier identifier, const TranslatableString& text, int type)
{
   auto button = safenew wxButton { this, wxID_ANY, text.Translation() };

   mButtonSizer->Add(button, wxSizerFlags {}.Border(wxLEFT, 8));

   if (type & EscButton)
      mEscButtonIdentifier = identifier;

   button->Bind(
      wxEVT_BUTTON, [this, identifier = std::move(identifier)](auto&)
      { EndDialog(identifier); });

   if (type & DefaultButton)
      button->SetDefault();
}

void AudioComDialogBase::SetDialogTitle(const TranslatableString& dialog)
{
   SetTitle(dialog);
}

bool AudioComDialogBase::HasSeparator() const
{
   return true;
}

void AudioComDialogBase::EndDialog(DialogButtonIdentifier identifier)
{
   mResultButtonIdentifier = std::move(identifier);
   Close();
}

namespace
{
struct IdleItem final
{
   std::function<bool()> Condition;
   std::function<void()> DialogFactory;
};

struct Idler final
{
   std::list<IdleItem> Items;

   Observer::Subscription Subsctiption;

   bool IdlerLocked {};

   Idler()
       : Subsctiption { AppEvents::OnAppIdle([this] { OnIdle(); }) }
   {
   }

   void OnIdle()
   {
      if (IdlerLocked)
         return;

      for (auto it = Items.begin(); it != Items.end();)
      {
         if (it->Condition())
         {
            IdlerLocked = true;

            auto swapFlag = finally([this] { IdlerLocked = false; });

            it->DialogFactory();
            it = Items.erase(it);
         }
         else
            ++it;
      }
   }
};
} // namespace

void ShowDialogOn(
   std::function<bool()> condition, std::function<void()> dialogFactory)
{
   static Idler idler;

   idler.Items.push_back({ std::move(condition), std::move(dialogFactory) });
}

} // namespace audacity::cloud::audiocom::sync