xref: /dports/devel/RStudio/rstudio-2021.09.1-372/src/gwt/src/org/rstudio/studio/client/workbench/views/environment/view/EnvironmentObjects.java

/*
 * EnvironmentObjects.java
 *
 * Copyright (C) 2021 by RStudio, PBC
 *
 * Unless you have received this program directly from RStudio pursuant
 * to the terms of a commercial license agreement with RStudio, then
 * this program is licensed to you under the terms of version 3 of the
 * GNU Affero General Public License. This program is distributed WITHOUT
 * ANY EXPRESS OR IMPLIED WARRANTY, INCLUDING THOSE OF NON-INFRINGEMENT,
 * MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. Please refer to the
 * AGPL (http://www.gnu.org/licenses/agpl-3.0.txt) for more details.
 *
 */

package org.rstudio.studio.client.workbench.views.environment.view;

import java.util.ArrayList;
import java.util.Collections;
import java.util.List;

import com.google.gwt.core.client.GWT;
import com.google.gwt.core.client.JsArray;
import com.google.gwt.core.client.JsArrayString;
import com.google.gwt.core.client.Scheduler;
import com.google.gwt.core.client.Scheduler.ScheduledCommand;
import com.google.gwt.event.dom.client.ScrollEvent;
import com.google.gwt.event.dom.client.ScrollHandler;
import com.google.gwt.uibinder.client.UiBinder;
import com.google.gwt.uibinder.client.UiField;
import com.google.gwt.user.client.Timer;
import com.google.gwt.user.client.ui.*;
import com.google.gwt.view.client.ListDataProvider;

import org.rstudio.core.client.Debug;
import org.rstudio.core.client.ElementIds;
import org.rstudio.core.client.theme.res.ThemeResources;
import org.rstudio.core.client.theme.res.ThemeStyles;
import org.rstudio.core.client.widget.FontSizer;
import org.rstudio.core.client.widget.Operation;
import org.rstudio.studio.client.common.SuperDevMode;
import org.rstudio.studio.client.workbench.views.environment.EnvironmentPane;
import org.rstudio.studio.client.workbench.views.environment.model.CallFrame;
import org.rstudio.studio.client.workbench.views.environment.model.RObject;
import org.rstudio.studio.client.workbench.views.environment.view.CallFramePanel.CallFramePanelHost;

public class EnvironmentObjects extends ResizeComposite
   implements CallFramePanelHost,
              EnvironmentObjectDisplay.Host
{
   private class ScrollIntoViewTimer extends Timer
   {
      @Override
      public void run()
      {
         try
         {
            if (row_ >= 0 && row_ <= objectDisplay_.getVisibleItemCount())
               objectDisplay_.getRowElement(row_).scrollIntoView();
         }
         catch (Exception e)
         {
            // silently drop exceptions as they are noisy + not actionable
         }
      }

      public void setRow(int row)
      {
         row_ = row;
      }

      private int row_ = 0;
   }

   // Public interfaces -------------------------------------------------------

   public interface Binder extends UiBinder<Widget, EnvironmentObjects>
   {
   }

   // Constructor -------------------------------------------------------------

   public EnvironmentObjects(EnvironmentObjectsObserver observer)
   {
      observer_ = observer;
      contextDepth_ = 0;
      environmentName_ = EnvironmentPane.GLOBAL_ENVIRONMENT_NAME;

      objectDisplayType_ = OBJECT_LIST_VIEW;
      objectDataProvider_ = new ListDataProvider<>();
      objectSort_ = new RObjectEntrySort();

      // timer used to scroll table element into view
      // a timer is required as we need to wait until table elements are
      // rendered and visible before we can scroll into view; otherwise
      // noisy exceptions will be emitted
      //
      // https://github.com/rstudio/rstudio/issues/5181
      scrollTimer_ = new ScrollIntoViewTimer();

      // set up the call frame panel
      callFramePanel_ = new CallFramePanel(observer_, this);

      initWidget(GWT.<Binder>create(Binder.class).createAndBindUi(this));

      splitPanel.addSouth(callFramePanel_, 150);
      splitPanel.setWidgetMinSize(callFramePanel_, style.headerRowHeight());

      setObjectDisplay(objectDisplayType_);

      FontSizer.applyNormalFontSize(this);
   }

   // Public methods ----------------------------------------------------------

   @Override
   public void onResize()
   {
      super.onResize();
      if (pendingCallFramePanelSize_)
      {
         autoSizeCallFramePanel();
      }
   }

   public void setContextDepth(int contextDepth)
   {
      if (contextDepth > 0)
      {
         splitPanel.setWidgetHidden(callFramePanel_, false);
         splitPanel.onResize();
      }
      else if (contextDepth == 0)
      {
         callFramePanel_.clearCallFrames();
         splitPanel.setWidgetHidden(callFramePanel_, true);
      }
      contextDepth_ = contextDepth;
   }

   public void addObject(RObject obj)
   {
      int idx = indexOfExistingObject(obj.getName());
      final RObjectEntry newEntry = entryFromRObject(obj);
      boolean added = false;

      // if the object is already in the environment, just update the value
      if (idx >= 0)
      {
         final RObjectEntry oldEntry = objectDataProvider_.getList().get(idx);

         if (oldEntry.rObject.getType() == obj.getType())
         {
            // type hasn't changed
            if (oldEntry.expanded &&
                newEntry.contentsAreDeferred)
            {
               // we're replacing an object that has server-deferred contents--
               // refill it immediately. (another approach would be to push the
               // set of currently expanded objects to the server so these
               // objects would show up on the client already expanded)
               fillEntryContents(newEntry, idx, false);
            }
            else
            {
               // contents aren't deferred, just use the expanded state directly
               newEntry.expanded = oldEntry.expanded;
            }
            objectDataProvider_.getList().set(idx, newEntry);
            added = true;
         }
         else
         {
            // types did change, do a full add/remove
            objectDataProvider_.getList().remove(idx);
         }

      }
      if (!added)
      {
         RObjectEntry entry = entryFromRObject(obj);
         idx = indexOfNewObject(entry);
         objectDataProvider_.getList().add(idx, entry);
      }
      updateCategoryLeaders(true);

      // scroll into view
      scrollTimer_.setRow(idx);
      scrollTimer_.schedule(100);
   }

   public void removeObject(String objName)
   {
      int idx = indexOfExistingObject(objName);
      if (idx >= 0)
      {
         objectDataProvider_.getList().remove(idx);
      }

      updateCategoryLeaders(true);
   }

   public void clearObjects()
   {
      objectDataProvider_.getList().clear();
   }

   public void clearSelection()
   {
      objectDisplay_.clearSelection();
   }

   // bulk add for objects--used on init or environment switch
   public void addObjects(JsArray<RObject> objects)
   {
      // create an entry for each object and sort the array
      int numObjects = objects.length();
      ArrayList<RObjectEntry> objectEntryList = new ArrayList<>();
      for (int i = 0; i < numObjects; i++)
      {
         RObjectEntry entry = entryFromRObject(objects.get(i));
         objectEntryList.add(entry);
      }
      Collections.sort(objectEntryList, objectSort_);

      // push the list into the UI and update category leaders
      objectDataProvider_.getList().addAll(objectEntryList);
      updateCategoryLeaders(false);

      if (useStatePersistence())
      {
         setDeferredState();
      }
   }

   public List<String> getSelectedObjects()
   {
      return objectDisplay_.getSelectedObjects();
   }

   public void setCallFrames(JsArray<CallFrame> frameList, boolean autoSize)
   {
      callFramePanel_.setCallFrames(frameList, contextDepth_);

      // if not auto-sizing we're done
      if (!autoSize)
         return;

      // if the parent panel has layout information, auto-size the call frame
      // panel (let GWT go first so the call frame panel visibility has
      // taken effect)
      if (splitPanel.getOffsetHeight() > 0)
      {
         Scheduler.get().scheduleDeferred(new ScheduledCommand()
         {
            @Override
            public void execute()
            {
               autoSizeCallFramePanel();
            }
         });
      }
      else
      {
         // wait until the split panel has layout information to compute the
         // correct size of the call frame panel
         pendingCallFramePanelSize_ = true;
      }
   }

   public void setEnvironmentName(String environmentName)
   {
      environmentName_ = environmentName;
      if (objectDisplay_ != null)
         objectDisplay_.setEnvironmentName(environmentName);
   }

   public int getScrollPosition()
   {
      return objectDisplay_.getScrollPanel().getVerticalScrollPosition();
   }

   public void setScrollPosition(int scrollPosition)
   {
      deferredScrollPosition_ = scrollPosition;
   }

   public void setExpandedObjects(JsArrayString objects)
   {
      deferredExpandedObjects_ = objects;
   }

   public void updateLineNumber (int newLineNumber)
   {
      callFramePanel_.updateLineNumber(newLineNumber);
   }

   public void setFilterText (String filterText)
   {
      filterText_ = filterText.toLowerCase();

      // Iterate over each entry in the list, and toggle its visibility based
      // on whether it matches the current filter text.
      List<RObjectEntry> objects = objectDataProvider_.getList();
      for (int i = 0; i < objects.size(); i++)
      {
         RObjectEntry entry = objects.get(i);
         boolean visible = matchesFilter(entry.rObject);
         // Redraw the object if its visibility status has changed, or if it's
         // visible (for visible entries we need to update the search highlight)
         if (visible != entry.visible || visible)
         {
            entry.visible = visible;
            redrawRowSafely(i);
         }
      }

      updateCategoryLeaders(true);
   }

   public int getObjectDisplay()
   {
      return objectDisplayType_;
   }

   // Sets the object display type. Waits for the event loop to finish because
   // of an apparent timing bug triggered by superdevmode (see case 3745).
   public void setObjectDisplay(int type)
   {
      deferredObjectDisplayType_ = type;
      Scheduler.get().scheduleDeferred(new ScheduledCommand()
      {
         @Override
         public void execute()
         {
            setDeferredObjectDisplay();
         }
      });
   }

   private void setDeferredObjectDisplay()
   {
      if (deferredObjectDisplayType_ == null)
      {
         return;
      }

      final int type = deferredObjectDisplayType_;

      // if we already have an active display of this type, do nothing
      if (type == objectDisplayType_ &&
          objectDisplay_ != null)
      {
         return;
      }

      // clean up previous object display, if we had one
      if (objectDisplay_ != null)
      {
         objectDataProvider_.removeDataDisplay(objectDisplay_);
         splitPanel.remove(objectDisplay_);
      }

      try
      {
         // create the new object display and wire it to the data source
         if (type == OBJECT_LIST_VIEW)
         {
            objectDisplay_ = new EnvironmentObjectList(
                                    this, observer_, environmentName_);
            objectSort_.setSortType(RObjectEntrySort.SORT_AUTO);
         }
         else if (type == OBJECT_GRID_VIEW)
         {
            objectDisplay_ = new EnvironmentObjectGrid(
                                    this, observer_, environmentName_);
            objectSort_.setSortType(RObjectEntrySort.SORT_COLUMN);
         }
      }
      catch (Throwable e)
      {
         // For reasons that are unclear, GWT sometimes barfs when trying to
         // create the virtual scrollbars in the DataGrid that drives the
         // environment list (it computes, and then tries to apply, a negative
         // height). This appears to only happen during superdevmode boot,
         // so try again (up to 5 times) if we're in superdevmode.

         if (SuperDevMode.isActive())
         {
            if (gridRenderRetryCount_ >= 5)
            {
               Debug.log("WARNING: Failed to render environment pane data grid");
            }
            gridRenderRetryCount_++;
            Debug.log("WARNING: Retrying environment data grid render (" +
                      gridRenderRetryCount_ + ")");
            Timer t = new Timer() {
               @Override
               public void run()
               {
                  setObjectDisplay(type);
               }
            };
            t.schedule(5);
         }

         return;
      }

      objectDisplayType_ = type;
      Collections.sort(objectDataProvider_.getList(), objectSort_);
      updateCategoryLeaders(false);
      objectDataProvider_.addDataDisplay(objectDisplay_);

      objectDisplay_.getScrollPanel().addScrollHandler(new ScrollHandler()
      {
         @Override
         public void onScroll(ScrollEvent event)
         {
            if (useStatePersistence())
            {
               deferredScrollPosition_ = getScrollPosition();
               observer_.setPersistedScrollPosition(deferredScrollPosition_);
            }
         }
      });

      objectDisplay_.setEmptyTableWidget(buildEmptyGridMessage());
      objectDisplay_.addStyleName(style.objectGrid());
      objectDisplay_.addStyleName(style.environmentPanel());
      splitPanel.add(objectDisplay_);
      deferredObjectDisplayType_ = null;
   }

   // CallFramePanelHost implementation ---------------------------------------

   @Override
   public void minimizeCallFramePanel()
   {
      callFramePanelHeight_ = splitPanel.getWidgetSize(callFramePanel_).intValue();
      splitPanel.setWidgetSize(callFramePanel_, style.headerRowHeight());
   }

   @Override
   public void restoreCallFramePanel()
   {
      splitPanel.setWidgetSize(callFramePanel_, callFramePanelHeight_);
      callFramePanel_.onResize();
   }

   @Override
   public boolean getShowInternalFunctions()
   {
      return observer_.getShowInternalFunctions();
   }

   @Override
   public void setShowInternalFunctions(boolean show)
   {
      observer_.setShowInternalFunctions(show);
   }

   // EnvironmentObjectsDisplay.Host implementation ---------------------------

   @Override
   public boolean enableClickableObjects()
   {
      return contextDepth_ < 2;
   }

   // we currently only set and/or get persisted state at the root context
   // level.
   @Override
   public boolean useStatePersistence()
   {
      return environmentName_ == EnvironmentPane.GLOBAL_ENVIRONMENT_NAME;
   }

   @Override
   public String getFilterText()
   {
      return filterText_;
   }

   @Override
   public int getSortColumn()
   {
      return objectSort_.getSortColumn();
   }

   @Override
   public void setSortColumn(int col)
   {
      objectSort_.setSortColumn(col);
      observer_.setViewDirty();
      Collections.sort(objectDataProvider_.getList(), objectSort_);
   }

   @Override
   public void toggleAscendingSort()
   {
      setAscendingSort(!objectSort_.getAscending());
   }

   @Override
   public boolean getAscendingSort()
   {
      return objectSort_.getAscending();
   }

   public void setAscendingSort(boolean ascending)
   {
      objectSort_.setAscending(ascending);
      observer_.setViewDirty();
      Collections.sort(objectDataProvider_.getList(), objectSort_);
   }

   public void setSort(int column, boolean ascending)
   {
      objectSort_.setSortColumn(column);
      objectSort_.setAscending(ascending);
      Collections.sort(objectDataProvider_.getList(), objectSort_);
   }

   @Override
   public void fillEntryContents(final RObjectEntry entry,
                                 final int idx,
                                 boolean drawProgress)
   {
      entry.expanded = false;
      entry.isExpanding = true;
      if (drawProgress)
         redrawRowSafely(idx);
      observer_.fillObjectContents(entry.rObject, new Operation() {
         public void execute()
         {
            entry.expanded = true;
            entry.isExpanding = false;
            redrawRowSafely(idx);
         }
      });
   }

   // Private methods: object management --------------------------------------

   private int indexOfExistingObject(String objectName)
   {
      List<RObjectEntry> objects = objectDataProvider_.getList();

      // find the position of the object in the list--we can't use binary
      // search here since we're matching on names and the list isn't sorted
      // by name (it's sorted by type, then name)
      int index;
      boolean foundObject = false;
      for (index = 0; index < objects.size(); index++)
      {
         if (objects.get(index).rObject.getName() == objectName)
         {
            foundObject = true;
            break;
         }
      }

      return foundObject ? index : -1;
   }

   // returns the position a new object entry should occupy in the table
   private int indexOfNewObject(RObjectEntry obj)
   {
      List<RObjectEntry> objects = objectDataProvider_.getList();
      int numObjects = objects.size();
      int idx;
      // consider: can we use binary search here?
      for (idx = 0; idx < numObjects; idx++)
      {
         if (objectSort_.compare(obj, objects.get(idx)) < 0)
         {
            break;
         }
      }
      return idx;
   }

   // after adds or removes, we need to tag the new category-leading objects
   private void updateCategoryLeaders(boolean redrawUpdatedRows)
   {
      // no need to do these model updates if we're not in the mode that
      // displays them
      if (objectDisplayType_ != OBJECT_LIST_VIEW)
         return;

      List<RObjectEntry> objects = objectDataProvider_.getList();

      // whether or not we've found a leader for each category
      Boolean[] leaders = { false, false, false, false };
      boolean foundFirstObject = false;

      for (int i = 0; i < objects.size(); i++)
      {
         RObjectEntry entry = objects.get(i);
         if (!entry.visible)
            continue;
         if (!foundFirstObject)
         {
            entry.isFirstObject = true;
            foundFirstObject = true;
         }
         else
         {
            entry.isFirstObject = false;
         }
         int category = entry.getCategory();
         Boolean leader = entry.isCategoryLeader;
         // if we haven't found a leader for this category yet, make this object
         // the leader if it isn't already
         if (!leaders[category])
         {
            leaders[category] = true;
            if (!leader)
            {
               entry.isCategoryLeader = true;
            }
         }
         // if this object is marked as the leader but we've already found a
         // leader, unmark it
         else if (leader)
         {
            entry.isCategoryLeader = false;
         }

         // if we changed the leader flag, redraw the row
         if (leader != entry.isCategoryLeader
             && redrawUpdatedRows)
         {
            redrawRowSafely(i);
         }
      }
   }

   private Widget buildEmptyGridMessage()
   {
      ThemeStyles styles = ThemeResources.INSTANCE.themeStyles();
      HTMLPanel messagePanel = new HTMLPanel("");
      messagePanel.setStyleName(style.emptyEnvironmentPanel());
      environmentEmptyMessage_ = new Label(EMPTY_ENVIRONMENT_MESSAGE);
      environmentEmptyMessage_.setStyleName(styles.subtitle());
      environmentEmptyMessage_.setStylePrimaryName(style.emptyEnvironmentMessage());
      ElementIds.assignElementId(environmentEmptyMessage_, ElementIds.ENV_EMPTY);
      messagePanel.add(environmentEmptyMessage_);
      return messagePanel;
   }

   private void autoSizeCallFramePanel()
   {
      // after setting the frames, resize the call frame panel to neatly
      // wrap the new list, up to a maximum of 2/3 of the height of the
      // split panel.
      int desiredCallFramePanelSize =
            callFramePanel_.getDesiredPanelHeight();

      if (splitPanel.getOffsetHeight() > 0)
      {
         desiredCallFramePanelSize = Math.min(
                 desiredCallFramePanelSize,
                 (int)(0.66 * splitPanel.getOffsetHeight()));
      }

      // if the panel is minimized, just update the cached height so it'll
      // get set to what we want when/if the panel is restored
      if (callFramePanel_.isMinimized())
      {
         callFramePanelHeight_ = desiredCallFramePanelSize;
      }
      else
      {
         splitPanel.setWidgetSize(
               callFramePanel_, desiredCallFramePanelSize);
         callFramePanel_.onResize();
         if (objectDisplay_ != null)
            objectDisplay_.onResize();
      }

      pendingCallFramePanelSize_ = false;
   }


   // Private methods: state persistence --------------------------------------

   private void setDeferredState()
   {
      Scheduler.get().scheduleDeferred(new ScheduledCommand()
      {
         @Override
         public void execute()
         {
            if (deferredExpandedObjects_ != null)
            {
               // loop through the objects in the list and check to see if each
               // is marked expanded in the persisted list of expanded objects
               List<RObjectEntry> objects = objectDataProvider_.getList();
               for (int idxObj = 0; idxObj < objects.size(); idxObj++)
               {
                  for (int idxExpanded = 0;
                       idxExpanded < deferredExpandedObjects_.length();
                       idxExpanded++)
                  {
                     if (objects.get(idxObj).rObject.getName() ==
                         deferredExpandedObjects_.get(idxExpanded))
                     {
                        objects.get(idxObj).expanded = true;
                        redrawRowSafely(idxObj);
                     }
                  }
               }
            }

            // set the cached scroll position
            objectDisplay_.getScrollPanel().setVerticalScrollPosition(
                    deferredScrollPosition_);

         }
      });
   }

   private boolean matchesFilter(RObject obj)
   {
      if (filterText_.isEmpty())
         return true;
      return obj.getName().toLowerCase().contains(filterText_) ||
             obj.getValue().toLowerCase().contains(filterText_);
   }

   private RObjectEntry entryFromRObject(RObject obj)
   {
      return new RObjectEntry(obj, matchesFilter(obj));
   }

   // for very large environments, the number of objects may exceed the number
   // of physical rows; avoid redrawing rows outside the bounds of the
   // container's physical limit
   private void redrawRowSafely(int idx)
   {
      boolean oob =
            idx >= MAX_ENVIRONMENT_OBJECTS ||
            idx >= objectDisplay_.getRowCount();

      if (oob)
         return;

      objectDisplay_.redrawRow(idx);
   }

   private final static String EMPTY_ENVIRONMENT_MESSAGE =
           "Environment is empty";

   public static final int OBJECT_LIST_VIEW = 0;
   public static final int OBJECT_GRID_VIEW = 1;

   @UiField EnvironmentStyle style;
   @UiField SplitLayoutPanel splitPanel;

   EnvironmentObjectDisplay objectDisplay_;
   CallFramePanel callFramePanel_;
   Label environmentEmptyMessage_;

   private ListDataProvider<RObjectEntry> objectDataProvider_;
   private RObjectEntrySort objectSort_;

   private EnvironmentObjectsObserver observer_;
   private int contextDepth_;
   private int callFramePanelHeight_;
   private int objectDisplayType_ = OBJECT_LIST_VIEW;
   private String filterText_ = "";
   private String environmentName_;

   private ScrollIntoViewTimer scrollTimer_;

   // deferred settings--set on load but not applied until we have data.
   private int deferredScrollPosition_ = 0;
   private JsArrayString deferredExpandedObjects_;
   private boolean pendingCallFramePanelSize_ = false;
   private Integer deferredObjectDisplayType_ = OBJECT_LIST_VIEW;
   private int gridRenderRetryCount_ = 0;

   public final static int MAX_ENVIRONMENT_OBJECTS = 1024;
}