Command input improvements: show common commands when focused, improve man command, move caret to end when inserting commands

Author: timothyschoen

Source/Sidebar/CommandInput.h

@@ -183,6 +183,7 @@ class CommandInput final
     : public Component
     , public KeyListener
     , public CommandProcessor
+    , public FocusChangeListener
     , public MarkupDisplay::URLHandler {
 public:
     explicit CommandInput(PluginEditor* editor)
@@ -261,12 +262,69 @@ class CommandInput final
             commandInput.setText(currentCommand);
 
         updateSize();
+
+        updateHelperCommands();
+        Desktop::getInstance().addFocusChangeListener(this);
     }
 
-    void updateSize()
+    void updateHelperCommands()
     {
-        int newHeight = std::max(commandInput.getTextHeight() + 4, 30);
-        setBounds(getX(), getBottom() - newHeight, getWidth(), newHeight);
+        auto isGlobalTarget = consoleTargetName == ">" || consoleTargetName == "lua >";
+        auto& currentHelpers = isGlobalTarget ? helperCommands : objectHelperCommands;
+
+        helperButtons.clear();
+
+        for (auto const& cmd : currentHelpers) {
+            auto* btn = helperButtons.add(new TextButton(cmd));
+            btn->setWantsKeyboardFocus(false);
+            btn->setColour(TextButton::buttonColourId, Colours::transparentBlack);
+            btn->setColour(TextButton::buttonOnColourId, Colours::transparentBlack);
+            btn->setColour(TextButton::textColourOffId, findColour(PlugDataColour::toolbarTextColourId));
+            btn->setColour(ComboBox::outlineColourId, Colours::transparentBlack);
+            btn->onClick = [this, cmd] {
+                commandInput.setText(cmd + " ", sendNotification);
+                commandInput.grabKeyboardFocus();
+                commandInput.moveCaretToEnd();
+            };
+            addChildComponent(btn);
+            btn->setVisible(hasInputFocus);
+        }
+        resized();
+    }
+
+    void updateSize(bool animate = false)
+    {
+        int const extraHeight = hasInputFocus ? helperRowHeight : 0;
+        int const newHeight = std::max(commandInput.getTextHeight() + 4, 30) + extraHeight;
+
+        auto const fromBounds = getBounds();
+        auto const targetBounds = Rectangle<int>(fromBounds.getX(),fromBounds.getBottom() - newHeight, fromBounds.getWidth(), newHeight);
+
+        if (fromBounds == targetBounds)
+            return;
+
+        if (!animate) {
+            sizeAnimator.complete();
+            setBounds(targetBounds);
+            return;
+        }
+
+        sizeAnimator = ValueAnimatorBuilder{}
+            .withEasing(Easings::createEaseInOut())
+            .withDurationMs(180)
+            .withValueChangedCallback([this, fromBounds, targetBounds](auto v) {
+                auto start = std::make_tuple(fromBounds.getX(), fromBounds.getY(), fromBounds.getWidth(), fromBounds.getHeight());
+                auto end = std::make_tuple(targetBounds.getX(), targetBounds.getY(), targetBounds.getWidth(), targetBounds.getHeight());
+                auto const [x, y, w, h] = makeAnimationLimits(start, end).lerp(v);
+                setBounds(x, y, w, h);
+            })
+            .build();
+
+        animatorUpdater.addAnimator(sizeAnimator, [this](){
+            for (auto* btn : helperButtons)
+                btn->setVisible(hasInputFocus);
+        });
+        sizeAnimator.start();
     }
 
     static int countBraces(String const& text)
@@ -561,48 +619,54 @@ class CommandInput final
 
                 case hash("?"):
                 case hash("help"):
-                    pd->logMessage(argv[2] + ": Show help");
+                    pd->logMessage(argv[1] + ": Show help");
                     break;
 
                 case hash("script"):
-                    pd->logMessage(argv[2] + ": Excute a Lua script from your search path. Usage: script <filename>");
+                    pd->logMessage(argv[1] + ": Excute a Lua script from your search path. Usage: script <filename>");
+                    break;
+
+                case hash("pd"):
+                    pd->logMessage(argv[1] + ": Send a message to pd. Usage: " + argv[1] + " <message>");
                     break;
 
                 case hash("cnv"):
                 case hash("canvas"):
-                    pd->logMessage(argv[2] + ": Send a message to current canvas. Usage: " + argv[2] + " <message>");
+                    pd->logMessage(argv[1] + ": Send a message to current canvas. Usage: " + argv[1] + " <message>");
                     break;
 
                 case hash("clear"):
-                    pd->logMessage(argv[2] + ": Clear console and command history");
+                    pd->logMessage(argv[1] + ": Clear console and command history");
                     break;
 
                 case hash("reset"):
-                    pd->logMessage(argv[2] + ": Reset Lua interpreter state");
+                    pd->logMessage(argv[1] + ": Reset Lua interpreter state");
                     break;
 
                 case hash("sel"):
                 case hash("select"):
-                    pd->logMessage(argv[2] + ": Select an object by ID or index. After selecting objects, you can send messages to them. Usage: " + argv[2] + " <id> or " + argv[2] + " <index>");
+                    pd->logMessage(argv[1] + ": Select an object by ID or index. After selecting objects, you can send messages to them. Usage: " + argv[1] + " <id> or " + argv[1] + " <index>");
                     break;
 
                 case hash(">"):
                 case hash("deselect"):
-                    pd->logMessage(argv[2] + ": Deselects all on current canvas");
+                    pd->logMessage(argv[1] + ": Deselects all on current canvas");
                     break;
 
                 case hash("ls"):
                 case hash("list"):
-                    pd->logMessage(argv[2] + ": Print a list of all object IDs on current canvas");
+                    pd->logMessage(argv[1] + ": Print a list of all object IDs on current canvas");
                     break;
 
                 case hash("find"):
                 case hash("search"):
-                    pd->logMessage(argv[2] + ": Search object IDs on current canvas. Usage: " + argv[2] + " <id>.");
+                    pd->logMessage(argv[1] + ": Search object IDs on current canvas. Usage: " + argv[1] + " <id>.");
                     break;
                 default:
+                    pd->logMessage("man: No manual for command: " + argv[1]);
                     break;
                 }
+                break;
             }
             case hash("?"):
             case hash("help"): {
@@ -696,20 +760,41 @@ class CommandInput final
 
     ~CommandInput() override
     {
+        Desktop::getInstance().removeFocusChangeListener(this);
         onDismiss();
     }
 
+    void globalFocusChanged(Component* focusedComponent) override
+    {
+        bool const focused = focusedComponent != nullptr
+            && (focusedComponent == &commandInput || isParentOf(focusedComponent));
+
+        if (focused == hasInputFocus)
+            return;
+
+        hasInputFocus = focused;
+        for (auto* btn : helperButtons)
+            btn->setVisible(false);
+
+        updateSize(true); // animate on focus change
+    }
+
     void handleURL(String const& url) override // when documentation links or codeblocks are clicked
     {
         commandInput.setText(url);
+        commandInput.moveCaretToEnd();
     }
 
     void paintOverChildren(Graphics& g) override
     {
         auto bounds = getLocalBounds();
+        int const inputHeight = std::max(commandInput.getTextHeight() + 4, 30);
+        auto const inputRow = bounds.removeFromBottom(inputHeight);
+
         g.setColour(PlugDataColours::dataColour);
         g.setFont(Fonts::getSemiBoldFont().withHeight(15));
-        g.drawText(consoleTargetName, bounds.getX() + 9, bounds.getY(), consoleTargetLength, bounds.getHeight() - 1, Justification::centredLeft);
+        g.drawText(consoleTargetName, inputRow.getX() + 9, inputRow.getY(),
+                   consoleTargetLength, inputRow.getHeight() - 1, Justification::centredLeft);
     }
 
     void paint(Graphics& g) override
@@ -721,10 +806,22 @@ class CommandInput final
 
     void resized() override
     {
-        auto inputBounds = getLocalBounds();
-        commandInput.setBounds(inputBounds.withTrimmedLeft(consoleTargetLength + 4).withTrimmedRight(30));
-        auto const buttonBounds = inputBounds.removeFromRight(30);
-        clearButton.setBounds(buttonBounds);
+        auto bounds = getLocalBounds();
+        int const inputHeight = std::max(commandInput.getTextHeight() + 4, 30);
+
+        if (hasInputFocus) {
+            auto const helperSpace = std::max(0, bounds.getHeight() - inputHeight);
+            auto helperBounds = bounds.removeFromTop(helperSpace);
+            helperBounds.removeFromLeft(8);
+            for (auto* btn : helperButtons) {
+                auto const w = CachedStringWidth<14>::calculateStringWidth(btn->getButtonText()) + 15;
+                btn->setBounds(helperBounds.removeFromLeft(w).reduced(1, 3));
+            }
+        }
+
+        auto const clearBounds = bounds.removeFromRight(30).removeFromBottom(inputHeight);
+        clearButton.setBounds(clearBounds);
+        commandInput.setBounds(bounds.withTrimmedLeft(consoleTargetLength + 4));
     }
 
     void setConsoleTargetName(String const& target)
@@ -734,6 +831,8 @@ class CommandInput final
             consoleTargetName = ">";
         consoleTargetLength = CachedStringWidth<15>::calculateStringWidth(consoleTargetName) + 4;
         commandInput.setBounds(commandInput.getBounds().withLeft(consoleTargetLength + 4));
+
+        updateHelperCommands();
         repaint();
     }
 
@@ -752,6 +851,7 @@ class CommandInput final
         } else {
             currentHistoryIndex = commandHistory.size() - 1;
         }
+        commandInput.moveCaretToEnd();
     }
 
     bool keyPressed(KeyPress const& key, Component*) override
@@ -806,6 +906,20 @@ class CommandInput final
     SmallIconButton clearButton = SmallIconButton(Icons::ClearText);
     SmallIconButton helpButton = SmallIconButton(Icons::Help);
 
+    OwnedArray<TextButton> helperButtons;
+    bool hasInputFocus = false;
+    static constexpr int helperRowHeight = 26;
+
+    VBlankAnimatorUpdater animatorUpdater { this };
+    Animator sizeAnimator = ValueAnimatorBuilder{}.build();
+
+    static inline StringArray const helperCommands = {
+        "help", "man", "ls", "sel", "cnv", "pd"
+    };
+    static inline StringArray const objectHelperCommands = {
+        "deselect",
+    };
+
     static inline String documentationString = {
         "Command input allows you to quickly send commands to objects, pd or the canvas.\n"
         "The following commands are available:\n"