bauiv1lib.playlist.edit

  1# Released under the MIT License. See LICENSE for details.
  2#
  3"""Provides a window for editing individual game playlists."""
  4
  5from __future__ import annotations
  6
  7import logging
  8from typing import TYPE_CHECKING, cast
  9
 10import bascenev1 as bs
 11import bauiv1 as bui
 12
 13if TYPE_CHECKING:
 14    from bauiv1lib.playlist.editcontroller import PlaylistEditController
 15
 16
 17class PlaylistEditWindow(bui.Window):
 18    """Window for editing an individual game playlist."""
 19
 20    def __init__(
 21        self,
 22        editcontroller: PlaylistEditController,
 23        transition: str = 'in_right',
 24    ):
 25        # pylint: disable=too-many-statements
 26        # pylint: disable=too-many-locals
 27        prev_selection: str | None
 28        self._editcontroller = editcontroller
 29        self._r = 'editGameListWindow'
 30        prev_selection = self._editcontroller.get_edit_ui_selection()
 31
 32        assert bui.app.classic is not None
 33        uiscale = bui.app.ui_v1.uiscale
 34        self._width = 870 if uiscale is bui.UIScale.SMALL else 670
 35        x_inset = 100 if uiscale is bui.UIScale.SMALL else 0
 36        self._height = (
 37            400
 38            if uiscale is bui.UIScale.SMALL
 39            else 470 if uiscale is bui.UIScale.MEDIUM else 540
 40        )
 41
 42        top_extra = 20 if uiscale is bui.UIScale.SMALL else 0
 43        super().__init__(
 44            root_widget=bui.containerwidget(
 45                size=(self._width, self._height + top_extra),
 46                transition=transition,
 47                scale=(
 48                    2.0
 49                    if uiscale is bui.UIScale.SMALL
 50                    else 1.3 if uiscale is bui.UIScale.MEDIUM else 1.0
 51                ),
 52                stack_offset=(
 53                    (0, -16) if uiscale is bui.UIScale.SMALL else (0, 0)
 54                ),
 55            )
 56        )
 57        cancel_button = bui.buttonwidget(
 58            parent=self._root_widget,
 59            position=(35 + x_inset, self._height - 60),
 60            scale=0.8,
 61            size=(175, 60),
 62            autoselect=True,
 63            label=bui.Lstr(resource='cancelText'),
 64            text_scale=1.2,
 65        )
 66        save_button = btn = bui.buttonwidget(
 67            parent=self._root_widget,
 68            position=(self._width - (195 + x_inset), self._height - 60),
 69            scale=0.8,
 70            size=(190, 60),
 71            autoselect=True,
 72            left_widget=cancel_button,
 73            label=bui.Lstr(resource='saveText'),
 74            text_scale=1.2,
 75        )
 76
 77        if bui.app.ui_v1.use_toolbars:
 78            bui.widget(
 79                edit=btn,
 80                right_widget=bui.get_special_widget('party_button'),
 81            )
 82
 83        bui.widget(
 84            edit=cancel_button,
 85            left_widget=cancel_button,
 86            right_widget=save_button,
 87        )
 88
 89        bui.textwidget(
 90            parent=self._root_widget,
 91            position=(-10, self._height - 50),
 92            size=(self._width, 25),
 93            text=bui.Lstr(resource=self._r + '.titleText'),
 94            color=bui.app.ui_v1.title_color,
 95            scale=1.05,
 96            h_align='center',
 97            v_align='center',
 98            maxwidth=270,
 99        )
100
101        v = self._height - 115.0
102
103        self._scroll_width = self._width - (205 + 2 * x_inset)
104
105        bui.textwidget(
106            parent=self._root_widget,
107            text=bui.Lstr(resource=self._r + '.listNameText'),
108            position=(196 + x_inset, v + 31),
109            maxwidth=150,
110            color=(0.8, 0.8, 0.8, 0.5),
111            size=(0, 0),
112            scale=0.75,
113            h_align='right',
114            v_align='center',
115        )
116
117        self._text_field = bui.textwidget(
118            parent=self._root_widget,
119            position=(210 + x_inset, v + 7),
120            size=(self._scroll_width - 53, 43),
121            text=self._editcontroller.getname(),
122            h_align='left',
123            v_align='center',
124            max_chars=40,
125            autoselect=True,
126            color=(0.9, 0.9, 0.9, 1.0),
127            description=bui.Lstr(resource=self._r + '.listNameText'),
128            editable=True,
129            padding=4,
130            on_return_press_call=self._save_press_with_sound,
131        )
132        bui.widget(edit=cancel_button, down_widget=self._text_field)
133
134        self._list_widgets: list[bui.Widget] = []
135
136        h = 40 + x_inset
137        v = self._height - 172.0
138
139        b_color = (0.6, 0.53, 0.63)
140        b_textcolor = (0.75, 0.7, 0.8)
141
142        v -= 2.0
143        v += 63
144
145        scl = (
146            1.03
147            if uiscale is bui.UIScale.SMALL
148            else 1.36 if uiscale is bui.UIScale.MEDIUM else 1.74
149        )
150        v -= 63.0 * scl
151
152        add_game_button = bui.buttonwidget(
153            parent=self._root_widget,
154            position=(h, v),
155            size=(110, 61.0 * scl),
156            on_activate_call=self._add,
157            on_select_call=bui.Call(self._set_ui_selection, 'add_button'),
158            autoselect=True,
159            button_type='square',
160            color=b_color,
161            textcolor=b_textcolor,
162            text_scale=0.8,
163            label=bui.Lstr(resource=self._r + '.addGameText'),
164        )
165        bui.widget(edit=add_game_button, up_widget=self._text_field)
166        v -= 63.0 * scl
167
168        self._edit_button = edit_game_button = bui.buttonwidget(
169            parent=self._root_widget,
170            position=(h, v),
171            size=(110, 61.0 * scl),
172            on_activate_call=self._edit,
173            on_select_call=bui.Call(self._set_ui_selection, 'editButton'),
174            autoselect=True,
175            button_type='square',
176            color=b_color,
177            textcolor=b_textcolor,
178            text_scale=0.8,
179            label=bui.Lstr(resource=self._r + '.editGameText'),
180        )
181        v -= 63.0 * scl
182
183        remove_game_button = bui.buttonwidget(
184            parent=self._root_widget,
185            position=(h, v),
186            size=(110, 61.0 * scl),
187            text_scale=0.8,
188            on_activate_call=self._remove,
189            autoselect=True,
190            button_type='square',
191            color=b_color,
192            textcolor=b_textcolor,
193            label=bui.Lstr(resource=self._r + '.removeGameText'),
194        )
195        v -= 40
196        h += 9
197        bui.buttonwidget(
198            parent=self._root_widget,
199            position=(h, v),
200            size=(42, 35),
201            on_activate_call=self._move_up,
202            label=bui.charstr(bui.SpecialChar.UP_ARROW),
203            button_type='square',
204            color=b_color,
205            textcolor=b_textcolor,
206            autoselect=True,
207            repeat=True,
208        )
209        h += 52
210        bui.buttonwidget(
211            parent=self._root_widget,
212            position=(h, v),
213            size=(42, 35),
214            on_activate_call=self._move_down,
215            autoselect=True,
216            button_type='square',
217            color=b_color,
218            textcolor=b_textcolor,
219            label=bui.charstr(bui.SpecialChar.DOWN_ARROW),
220            repeat=True,
221        )
222
223        v = self._height - 100
224        scroll_height = self._height - 155
225        scrollwidget = bui.scrollwidget(
226            parent=self._root_widget,
227            position=(160 + x_inset, v - scroll_height),
228            highlight=False,
229            on_select_call=bui.Call(self._set_ui_selection, 'gameList'),
230            size=(self._scroll_width, (scroll_height - 15)),
231        )
232        bui.widget(
233            edit=scrollwidget,
234            left_widget=add_game_button,
235            right_widget=scrollwidget,
236        )
237        self._columnwidget = bui.columnwidget(
238            parent=scrollwidget, border=2, margin=0
239        )
240        bui.widget(edit=self._columnwidget, up_widget=self._text_field)
241
242        for button in [add_game_button, edit_game_button, remove_game_button]:
243            bui.widget(
244                edit=button, left_widget=button, right_widget=scrollwidget
245            )
246
247        self._refresh()
248
249        bui.buttonwidget(edit=cancel_button, on_activate_call=self._cancel)
250        bui.containerwidget(
251            edit=self._root_widget,
252            cancel_button=cancel_button,
253            selected_child=scrollwidget,
254        )
255
256        bui.buttonwidget(edit=save_button, on_activate_call=self._save_press)
257        bui.containerwidget(edit=self._root_widget, start_button=save_button)
258
259        if prev_selection == 'add_button':
260            bui.containerwidget(
261                edit=self._root_widget, selected_child=add_game_button
262            )
263        elif prev_selection == 'editButton':
264            bui.containerwidget(
265                edit=self._root_widget, selected_child=edit_game_button
266            )
267        elif prev_selection == 'gameList':
268            bui.containerwidget(
269                edit=self._root_widget, selected_child=scrollwidget
270            )
271
272    def _set_ui_selection(self, selection: str) -> None:
273        self._editcontroller.set_edit_ui_selection(selection)
274
275    def _cancel(self) -> None:
276        from bauiv1lib.playlist.customizebrowser import (
277            PlaylistCustomizeBrowserWindow,
278        )
279
280        # no-op if our underlying widget is dead or on its way out.
281        if not self._root_widget or self._root_widget.transitioning_out:
282            return
283
284        bui.getsound('powerdown01').play()
285        bui.containerwidget(edit=self._root_widget, transition='out_right')
286        assert bui.app.classic is not None
287        bui.app.ui_v1.set_main_menu_window(
288            PlaylistCustomizeBrowserWindow(
289                transition='in_left',
290                sessiontype=self._editcontroller.get_session_type(),
291                select_playlist=(
292                    self._editcontroller.get_existing_playlist_name()
293                ),
294            ).get_root_widget(),
295            from_window=self._root_widget,
296        )
297
298    def _add(self) -> None:
299        # Store list name then tell the session to perform an add.
300        self._editcontroller.setname(
301            cast(str, bui.textwidget(query=self._text_field))
302        )
303        self._editcontroller.add_game_pressed()
304
305    def _edit(self) -> None:
306        # Store list name then tell the session to perform an add.
307        self._editcontroller.setname(
308            cast(str, bui.textwidget(query=self._text_field))
309        )
310        self._editcontroller.edit_game_pressed()
311
312    def _save_press(self) -> None:
313        from bauiv1lib.playlist.customizebrowser import (
314            PlaylistCustomizeBrowserWindow,
315        )
316
317        # no-op if our underlying widget is dead or on its way out.
318        if not self._root_widget or self._root_widget.transitioning_out:
319            return
320
321        plus = bui.app.plus
322        assert plus is not None
323
324        new_name = cast(str, bui.textwidget(query=self._text_field))
325        if (
326            new_name != self._editcontroller.get_existing_playlist_name()
327            and new_name
328            in bui.app.config[
329                self._editcontroller.get_config_name() + ' Playlists'
330            ]
331        ):
332            bui.screenmessage(
333                bui.Lstr(resource=self._r + '.cantSaveAlreadyExistsText')
334            )
335            bui.getsound('error').play()
336            return
337        if not new_name:
338            bui.getsound('error').play()
339            return
340        if not self._editcontroller.get_playlist():
341            bui.screenmessage(
342                bui.Lstr(resource=self._r + '.cantSaveEmptyListText')
343            )
344            bui.getsound('error').play()
345            return
346
347        # We couldn't actually replace the default list anyway, but disallow
348        # using its exact name to avoid confusion.
349        if new_name == self._editcontroller.get_default_list_name().evaluate():
350            bui.screenmessage(
351                bui.Lstr(resource=self._r + '.cantOverwriteDefaultText')
352            )
353            bui.getsound('error').play()
354            return
355
356        # If we had an old one, delete it.
357        if self._editcontroller.get_existing_playlist_name() is not None:
358            plus.add_v1_account_transaction(
359                {
360                    'type': 'REMOVE_PLAYLIST',
361                    'playlistType': self._editcontroller.get_config_name(),
362                    'playlistName': (
363                        self._editcontroller.get_existing_playlist_name()
364                    ),
365                }
366            )
367
368        plus.add_v1_account_transaction(
369            {
370                'type': 'ADD_PLAYLIST',
371                'playlistType': self._editcontroller.get_config_name(),
372                'playlistName': new_name,
373                'playlist': self._editcontroller.get_playlist(),
374            }
375        )
376        plus.run_v1_account_transactions()
377
378        bui.containerwidget(edit=self._root_widget, transition='out_right')
379        bui.getsound('gunCocking').play()
380        assert bui.app.classic is not None
381        bui.app.ui_v1.set_main_menu_window(
382            PlaylistCustomizeBrowserWindow(
383                transition='in_left',
384                sessiontype=self._editcontroller.get_session_type(),
385                select_playlist=new_name,
386            ).get_root_widget(),
387            from_window=self._root_widget,
388        )
389
390    def _save_press_with_sound(self) -> None:
391        bui.getsound('swish').play()
392        self._save_press()
393
394    def _select(self, index: int) -> None:
395        self._editcontroller.set_selected_index(index)
396
397    def _refresh(self) -> None:
398        # Need to grab this here as rebuilding the list will
399        # change it otherwise.
400        old_selection_index = self._editcontroller.get_selected_index()
401
402        while self._list_widgets:
403            self._list_widgets.pop().delete()
404        for index, pentry in enumerate(self._editcontroller.get_playlist()):
405            try:
406                cls = bui.getclass(pentry['type'], subclassof=bs.GameActivity)
407                desc = cls.get_settings_display_string(pentry)
408            except Exception:
409                logging.exception('Error in playlist refresh.')
410                desc = "(invalid: '" + pentry['type'] + "')"
411
412            txtw = bui.textwidget(
413                parent=self._columnwidget,
414                size=(self._width - 80, 30),
415                on_select_call=bui.Call(self._select, index),
416                always_highlight=True,
417                color=(0.8, 0.8, 0.8, 1.0),
418                padding=0,
419                maxwidth=self._scroll_width * 0.93,
420                text=desc,
421                on_activate_call=self._edit_button.activate,
422                v_align='center',
423                selectable=True,
424            )
425            bui.widget(edit=txtw, show_buffer_top=50, show_buffer_bottom=50)
426
427            # Wanna be able to jump up to the text field from the top one.
428            if index == 0:
429                bui.widget(edit=txtw, up_widget=self._text_field)
430            self._list_widgets.append(txtw)
431            if old_selection_index == index:
432                bui.columnwidget(
433                    edit=self._columnwidget,
434                    selected_child=txtw,
435                    visible_child=txtw,
436                )
437
438    def _move_down(self) -> None:
439        playlist = self._editcontroller.get_playlist()
440        index = self._editcontroller.get_selected_index()
441        if index >= len(playlist) - 1:
442            return
443        tmp = playlist[index]
444        playlist[index] = playlist[index + 1]
445        playlist[index + 1] = tmp
446        index += 1
447        self._editcontroller.set_playlist(playlist)
448        self._editcontroller.set_selected_index(index)
449        self._refresh()
450
451    def _move_up(self) -> None:
452        playlist = self._editcontroller.get_playlist()
453        index = self._editcontroller.get_selected_index()
454        if index < 1:
455            return
456        tmp = playlist[index]
457        playlist[index] = playlist[index - 1]
458        playlist[index - 1] = tmp
459        index -= 1
460        self._editcontroller.set_playlist(playlist)
461        self._editcontroller.set_selected_index(index)
462        self._refresh()
463
464    def _remove(self) -> None:
465        playlist = self._editcontroller.get_playlist()
466        index = self._editcontroller.get_selected_index()
467        if not playlist:
468            return
469        del playlist[index]
470        if index >= len(playlist):
471            index = len(playlist) - 1
472        self._editcontroller.set_playlist(playlist)
473        self._editcontroller.set_selected_index(index)
474        bui.getsound('shieldDown').play()
475        self._refresh()