PackageList.cs 14.4 KB
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 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430
using UnityEngine.Experimental.UIElements;
using System;
using System.Collections.Generic;
using System.Linq;
using UnityEngine;

namespace UnityEditor.PackageManager.UI
{
#if !UNITY_2018_3_OR_NEWER
    internal class PackageListFactory : UxmlFactory<PackageList>
    {
        protected override PackageList DoCreate(IUxmlAttributes bag, CreationContext cc)
        {
            return new PackageList();
        }
    }
#endif

    internal class PackageList : VisualElement
    {
#if UNITY_2018_3_OR_NEWER
        internal new class UxmlFactory : UxmlFactory<PackageList> {}
#endif

        public event Action<Package> OnSelected = delegate {};
        public event Action OnLoaded = delegate {};
        public event Action OnFocusChange = delegate {};

        private readonly VisualElement root;
        internal PackageItem selectedItem;
        private List<PackageGroup> Groups;

        public PackageList()
        {
            Groups = new List<PackageGroup>();

            root = Resources.GetTemplate("PackageList.uxml");
            Add(root);
            root.StretchToParentSize();

            UIUtils.SetElementDisplay(Empty, false);
            UIUtils.SetElementDisplay(NoResult, false);

            PackageCollection.Instance.OnPackagesChanged += SetPackages;

            RegisterCallback<AttachToPanelEvent>(OnEnterPanel);
            RegisterCallback<DetachFromPanelEvent>(OnLeavePanel);

            Reload();
        }

        public void GrabFocus()
        {
            if (selectedItem == null)
                return;

            selectedItem.Focus();
        }

        public void ShowResults(PackageItem item)
        {
            NoResultText.text = string.Empty;
            UIUtils.SetElementDisplay(NoResult, false);

            Select(item);

            EditorApplication.delayCall += ScrollIfNeeded;

            UpdateGroups();
        }

        public void ShowNoResults()
        {
            if (string.IsNullOrEmpty(PackageSearchFilter.Instance.SearchText))
                NoResultText.text = "No packages found";
            else
                NoResultText.text = string.Format("No results for \"{0}\"", PackageSearchFilter.Instance.SearchText);

            UIUtils.SetElementDisplay(NoResult, true);
            foreach (var group in Groups)
            {
                UIUtils.SetElementDisplay(group, false);
            }
            Select(null);
            OnSelected(null);
        }

        private void UpdateGroups()
        {
            foreach (var group in Groups)
            {
                UIUtils.SetElementDisplay(group, group.packageItems.Any(item => !UIUtils.IsElementDisplayNone(item)));
            }
        }

        private void OnEnterPanel(AttachToPanelEvent e)
        {
            panel.visualTree.RegisterCallback<KeyDownEvent>(OnKeyDownShortcut);
        }

        private void OnLeavePanel(DetachFromPanelEvent e)
        {
            panel.visualTree.UnregisterCallback<KeyDownEvent>(OnKeyDownShortcut);
        }

        private void ScrollIfNeeded()
        {
            EditorApplication.delayCall -= ScrollIfNeeded;

            if (selectedItem == null)
                return;

            var minY = List.worldBound.yMin;
            var maxY = List.worldBound.yMax;
            var itemMinY = selectedItem.worldBound.yMin;
            var itemMaxY = selectedItem.worldBound.yMax;
            var scroll = List.scrollOffset;

            if (itemMinY < minY)
            {
                scroll.y -= minY - itemMinY;
                if (scroll.y <= minY)
                    scroll.y = 0;
                List.scrollOffset = scroll;
            }
            else if (itemMaxY > maxY)
            {
                scroll.y += itemMaxY - maxY;
                List.scrollOffset = scroll;
            }
        }

        private static VisualElement FindNextSiblingByCondition(VisualElement element, Func<VisualElement, bool> matchFunc, bool reverseOrder)
        {
            if (element == null)
                return null;

            var parent = element.parent;
            var index = parent.IndexOf(element);
            if (reverseOrder)
            {
                for (var i = index - 1; i >= 0; i--)
                {
                    var nextElement = parent.ElementAt(i);
                    if (matchFunc(nextElement))
                        return nextElement;
                }
            }
            else
            {
                for (var i = index + 1; i < parent.childCount; i++)
                {
                    var nextElement = parent.ElementAt(i);
                    if (matchFunc(nextElement))
                        return nextElement;
                }
            }
            return null;
        }

        private static PackageItem FindNextVisiblePackageItem(PackageItem item, bool reverseOrder)
        {
            PackageItem nextVisibleItem = null;
            if (item.packageGroup.IsExpanded)
                nextVisibleItem = FindNextSiblingByCondition(item, UIUtils.IsElementVisible, reverseOrder) as PackageItem;

            if (nextVisibleItem == null)
            {
                Func<VisualElement, bool> expandedNonEmptyGroup = (element) =>
                {
                    var group = element as PackageGroup;
                    return group.IsExpanded && group.packageItems.Any(p => !UIUtils.IsElementDisplayNone(p));
                };
                var nextGroup = FindNextSiblingByCondition(item.packageGroup, expandedNonEmptyGroup, reverseOrder) as PackageGroup;
                if (nextGroup != null)
                    nextVisibleItem = reverseOrder ? nextGroup.packageItems.LastOrDefault(p => !UIUtils.IsElementDisplayNone(p)) : nextGroup.packageItems.FirstOrDefault(p => !UIUtils.IsElementDisplayNone(p));
            }
            return nextVisibleItem;
        }

        private static PackageItem FindPackageItemPageUpOrPageDown(PackageItem item, bool isPageUp)
        {
            PackageItem targetItem = null;
            if (item.packageGroup.IsExpanded)
                targetItem = (isPageUp ? item.parent.Children().FirstOrDefault(p => !UIUtils.IsElementDisplayNone(p)) 
                    : item.parent.Children().LastOrDefault(p => !UIUtils.IsElementDisplayNone(p))) as PackageItem;

            if (targetItem == item)
                targetItem = null;

            if (targetItem == null)
            {
                Func<VisualElement, bool> expandedNonEmptyGroup = (element) =>
                {
                    var group = element as PackageGroup;
                    return group.IsExpanded && group.packageItems.Any(p => !UIUtils.IsElementDisplayNone(p));
                };
                var nextGroup = FindNextSiblingByCondition(item.packageGroup, expandedNonEmptyGroup, isPageUp) as PackageGroup;
                if (nextGroup != null)
                    targetItem = (isPageUp ? nextGroup.packageItems.LastOrDefault(p => p != item && !UIUtils.IsElementDisplayNone(p))
                    : nextGroup.packageItems.FirstOrDefault(p => p != item && !UIUtils.IsElementDisplayNone(p))) as PackageItem;
            }
            return targetItem;
        }

        private void OnKeyDownShortcut(KeyDownEvent evt)
        {
            if (selectedItem == null)
                return;

            if (evt.keyCode == KeyCode.Tab)
            {
                OnFocusChange();
                evt.StopPropagation();
                return;
            }

            if (evt.keyCode == KeyCode.UpArrow)
            {
                var nextVisibleItem = FindNextVisiblePackageItem(selectedItem, true);
                if (nextVisibleItem != null)
                {
                    Select(nextVisibleItem);
                    ScrollIfNeeded();
                }
                evt.StopPropagation();
                return;
            }

            if (evt.keyCode == KeyCode.DownArrow)
            {
                var nextVisibleItem = FindNextVisiblePackageItem(selectedItem, false);
                if (nextVisibleItem != null)
                {
                    Select(nextVisibleItem);
                    ScrollIfNeeded();
                }
                evt.StopPropagation();
                return;
            }

            if (evt.keyCode == KeyCode.PageUp)
            {
                var targetItem = FindPackageItemPageUpOrPageDown(selectedItem, true);
                if (targetItem != null)
                {
                    Select(targetItem);
                    ScrollIfNeeded();
                }
                evt.StopPropagation();
                return;
            }

            if (evt.keyCode == KeyCode.PageDown)
            {
                var targetItem = FindPackageItemPageUpOrPageDown(selectedItem, false);
                if (targetItem != null)
                {
                    Select(targetItem);
                    ScrollIfNeeded();
                }
                evt.StopPropagation();
                return;
            }
        }

        private void Reload()
        {
            // Force a re-init to initial condition
            PackageCollection.Instance.UpdatePackageCollection();
            SelectLastSelection();
        }

        private void ClearAll()
        {
            List.Clear();
            Groups.Clear();

            UIUtils.SetElementDisplay(Empty, false);
            UIUtils.SetElementDisplay(NoResult, false);
        }

        private void SetPackages(IEnumerable<Package> packages)
        {
            if (PackageCollection.Instance.Filter == PackageFilter.Modules)
            {
                packages = packages.Where(pkg => pkg.IsBuiltIn);
            }
            else if (PackageCollection.Instance.Filter == PackageFilter.Unity)
            {
                packages = packages.Where(pkg => !pkg.IsBuiltIn && pkg.IsUnityPackage && !(pkg.Current != null && (pkg.Current.IsLocal || pkg.Current.IsInDevelopment)));
            }
            else if (PackageCollection.Instance.Filter == PackageFilter.Other)
            {
                packages = packages.Where(pkg => !pkg.IsBuiltIn && !pkg.IsUnityPackage && !(pkg.Current != null && (pkg.Current.IsLocal || pkg.Current.IsInDevelopment)));
            }
            else // PackageCollection.Instance.Filter == PackageFilter.Local
            {
                packages = packages.Where(pkg => !pkg.IsBuiltIn && pkg.Current != null);
            }

            OnLoaded();
            ClearAll();

            var lastSelection = PackageCollection.Instance.SelectedPackage;
            Select(null);

            PackageItem defaultSelection = null;

            foreach (var package in packages)
            {
                var item = AddPackage(package);

                if (null == selectedItem && defaultSelection == null)
                    defaultSelection = item;

                if (null == selectedItem && !string.IsNullOrEmpty(lastSelection) && package.Name.Equals(lastSelection))
                    Select(item);
            }

            if (selectedItem == null)
                Select(defaultSelection);

            PackageFiltering.FilterPackageList(this);
        }

        public void SelectLastSelection()
        {
            var lastSelection = PackageCollection.Instance.SelectedPackage;
            if (lastSelection == null)
                return;

            var list = List.Query<PackageItem>().ToList();
            PackageItem defaultSelection = null;

            foreach (var item in list)
            {
                if (defaultSelection == null)
                    defaultSelection = item;

                if (!string.IsNullOrEmpty(lastSelection) && item.package.Name.Equals(lastSelection))
                {
                    defaultSelection = item;
                    break;
                }
            }

            selectedItem = null;
            Select(defaultSelection);
        }

        private PackageItem AddPackage(Package package)
        {
            var groupName = PackageCollection.GetGroupName(package);
            var group = GetOrCreateGroup(groupName, package.IsBuiltIn || (PackageCollection.Instance.Filter == PackageFilter.Unity && package.IsUnityPackage));
            var packageItem = group.AddPackage(package);

            packageItem.OnSelected += Select;

            return packageItem;
        }

        private PackageGroup GetOrCreateGroup(string groupName, bool hidden)
        {
            foreach (var g in Groups)
            {
                if (g.name == groupName)
                    return g;
            }

            var group = new PackageGroup(groupName, hidden);
            if (!hidden)
            {
                group.OnGroupToggle += value =>
                {
                    if (value)
                    {
                        PackageCollection.Instance.CollapsedGroups.Remove(group.name);

                        if (group.Contains(selectedItem))
                            EditorApplication.delayCall += ScrollIfNeeded;
                    }
                    else
                    {
                        if (!PackageCollection.Instance.CollapsedGroups.Contains(group.name))
                            PackageCollection.Instance.CollapsedGroups.Add(group.name);
                    }
                };
            }

            group.SetExpanded(!PackageCollection.Instance.CollapsedGroups.Contains(groupName));

            Groups.Add(group);
            List.Add(group);
            return group;
        }

        private void Select(PackageItem packageItem)
        {
            if (packageItem == selectedItem)
            {
                if (selectedItem != null)
                    selectedItem.SetSelected(true);
                return;
            }

            var selectedPackageName = packageItem != null ? packageItem.package.Name : null;
            PackageCollection.Instance.SelectedPackage = selectedPackageName;

            if (selectedItem != null)
                selectedItem.SetSelected(false); // Clear Previous selection

            selectedItem = packageItem;
            if (selectedItem == null)
            {
                OnSelected(null);
                return;
            }

            selectedItem.SetSelected(true);
            ScrollIfNeeded();
            OnSelected(selectedItem.package);
        }

        private ScrollView List { get { return root.Q<ScrollView>("scrollView"); } }
        private VisualElement Empty { get { return root.Q<VisualElement>("emptyArea"); } }
        private VisualElement NoResult { get { return root.Q<VisualElement>("noResult"); } }
        private Label NoResultText { get { return root.Q<Label>("noResultText"); } }
    }
}