------------------------------------------------------------------------------
--                                  G P S                                   --
--                                                                          --
--                     Copyright (C) 2016-2019, AdaCore                     --
--                                                                          --
-- This is free software;  you can redistribute it  and/or modify it  under --
-- terms of the  GNU General Public License as published  by the Free Soft- --
-- ware  Foundation;  either version 3,  or (at your option) any later ver- --
-- sion.  This software is distributed in the hope  that it will be useful, --
-- but WITHOUT ANY WARRANTY;  without even the implied warranty of MERCHAN- --
-- TABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public --
-- License for  more details.  You should have  received  a copy of the GNU --
-- General  Public  License  distributed  with  this  software;   see  file --
-- COPYING3.  If not, go to http://www.gnu.org/licenses for a complete copy --
-- of the license.                                                          --
------------------------------------------------------------------------------

with Ada.Characters.Handling;            use Ada.Characters.Handling;
with Ada.Containers.Indefinite_Hashed_Maps;
with Ada.Strings.Hash;
with Commands, Commands.Interactive;     use Commands, Commands.Interactive;
with Default_Preferences;                use Default_Preferences;
with Gdk.Rectangle;                      use Gdk.Rectangle;
with Gdk.RGBA;                           use Gdk.RGBA;
with Generic_Views;                      use Generic_Views;
with Glib;                               use Glib;
with Glib.Convert;                       use Glib.Convert;
with Glib.Object;                        use Glib.Object;
with Glib.Values;                        use Glib.Values;
with Glib_Values_Utils;                  use Glib_Values_Utils;
with GPS.Kernel.Actions;                 use GPS.Kernel.Actions;
with GPS.Kernel.Hooks;                   use GPS.Kernel.Hooks;
with GPS.Kernel.MDI;                     use GPS.Kernel.MDI;
with GPS.Kernel.Modules;                 use GPS.Kernel.Modules;
with GPS.Kernel.Modules.UI;              use GPS.Kernel.Modules.UI;
with GPS.Kernel.Preferences;             use GPS.Kernel.Preferences;
with GPS.Intl;                           use GPS.Intl;
with GPS.Search;                         use GPS.Search;
with Gtkada.MDI;                         use Gtkada.MDI;
with Gtkada.Tree_View;                   use Gtkada.Tree_View;
with Gtk.Box;                            use Gtk.Box;
with Gtk.Cell_Renderer;                  use Gtk.Cell_Renderer;
with Gtk.Cell_Renderer_Pixbuf;           use Gtk.Cell_Renderer_Pixbuf;
with Gtk.Cell_Renderer_Text;             use Gtk.Cell_Renderer_Text;
with Gtk.Enums;                          use Gtk.Enums;
with Gtk.Gesture_Long_Press;             use Gtk.Gesture_Long_Press;
with Gtk.Gesture_Multi_Press;            use Gtk.Gesture_Multi_Press;
with Gtk.Label;                          use Gtk.Label;
with Gtk.Menu;                           use Gtk.Menu;
with Gtk.Scrolled_Window;                use Gtk.Scrolled_Window;
with Gtk.Tree_Model;                     use Gtk.Tree_Model;
with Gtk.Tree_View_Column;               use Gtk.Tree_View_Column;
with Gtk.Widget;                         use Gtk.Widget;
with GUI_Utils;                          use GUI_Utils;
with Tooltips;                           use Tooltips;
with VCS2.Engines;                       use VCS2.Engines;
with VCS2.Views;                         use VCS2.Views;

package body VCS2.Branches is

   Column_Name           : constant := 0;
   Column_Foreground     : constant := 1;
   Column_Emblem         : constant := 2;
   Column_Emblem_Visible : constant := 3;
   Column_Icon           : constant := 4;
   Column_Icon_Visible   : constant := 5;
   Column_Id             : constant := 6;
   Column_Can_Rename     : constant := 7;
   subtype All_Columns is Gint range Column_Name .. Column_Can_Rename;

   package Path_Maps is new Ada.Containers.Indefinite_Hashed_Maps
     (Key_Type        => String,
      Element_Type    => Gtk_Tree_Path,
      Hash            => Ada.Strings.Hash,
      Equivalent_Keys => "=");

   type Branches_Config is record
      Initialized : Boolean := False;
   end record;

   type Branches_Tree_Record is new Tree_View_Record with record
      Kernel      : Kernel_Handle;
      Name_Render : Gtk_Cell_Renderer_Text;
      Config      : Branches_Config;
      Categories  : Path_Maps.Map;
      User_Filter : GPS.Search.Search_Pattern_Access;
   end record;
   type Branches_Tree is access all Branches_Tree_Record'Class;
   overriding function Is_Visible
     (Self : not null access Branches_Tree_Record;
      Iter : Gtk.Tree_Model.Gtk_Tree_Iter) return Boolean;
   overriding procedure On_Edited
     (Self        : not null access Branches_Tree_Record;
      Store_Iter  : Gtk_Tree_Iter;
      View_Column : Edited_Column_Id;
      Text        : String);

   function Expansion_Id_From_Node
     (Self       : not null access Branches_Tree_Record'Class;
      Store_Iter : Gtk_Tree_Iter) return String;

   Category_Id_Prefix : constant String := "GPS@@";
   --  Special prefix added to the name of categories to make a special id used
   --  to restore expansion

   package Branches_Expansion is new Expansion_Support
     (Tree_Record   => Branches_Tree_Record,
      Id            => String,
      Get_Id        => Expansion_Id_From_Node,
      Hash          => Ada.Strings.Hash);

   type Branches_View_Record is new Base_VCS_View_Record with record
      Emblem      : Gtk_Cell_Renderer_Text;
      Multipress  : Gtk_Gesture_Multi_Press;
      Longpress   : Gtk_Gesture_Long_Press;
   end record;
   overriding procedure Refresh (Self : not null access Branches_View_Record);
   overriding procedure On_Preferences_Changed
     (Self    : not null access Branches_View_Record;
      Pref    : Preference);
   overriding procedure On_Create
     (Self    : not null access Branches_View_Record;
      Child   : not null access GPS.Kernel.MDI.GPS_MDI_Child_Record'Class);
   overriding procedure Create_Menu
     (View    : not null access Branches_View_Record;
      Menu    : not null access Gtk.Menu.Gtk_Menu_Record'Class);
   overriding procedure Filter_Changed
     (Self    : not null access Branches_View_Record;
      Pattern : in out GPS.Search.Search_Pattern_Access);

   function Initialize
     (Self : access Branches_View_Record'Class) return Gtk_Widget;
   --  Create a new view

   type Branches_Child_Record is new GPS_MDI_Child_Record with null record;

   package Branches_Views is new Generic_Views.Simple_Views
     (Module_Name        => "Branches",
      View_Name          => "Branches",
      Formal_View_Record => Branches_View_Record,
      Formal_MDI_Child   => Branches_Child_Record,
      Reuse_If_Exist     => True,
      Local_Toolbar      => True,
      Local_Config       => True,
      Areas              => Gtkada.MDI.Both,
      Position           => Position_Left,
      Initialize         => Initialize);
   use Branches_Views;
   subtype Branches_View is Branches_Views.View_Access;

   function Create_Category
     (Self  : not null access Branches_View_Record'Class;
      Name  : String) return Gtk_Tree_Iter;
   --  Create a new top-level category node if none exists already for this
   --  category.

   procedure Create_Node
     (Self       : not null access Branches_View_Record'Class;
      Category   : Gtk_Tree_Iter;
      Icon_Name  : String;
      Info       : Branch_Info;
      Can_Rename : Boolean);
   --  Create nodes in the tree

   function Create_Group
     (Self      : not null access Branches_View_Record'Class;
      Icon_Name : String;
      Name      : String;
      Parent    : Gtk_Tree_Iter) return Gtk_Tree_Iter;
   --  Create a group of nodes

   type Branches_Visitor is new Task_Visitor with record
      Kernel    : Kernel_Handle;
      Expansion : Branches_Expansion.Expansion_Status;
   end record;
   overriding procedure On_Branches
     (Self       : not null access Branches_Visitor;
      Category   : String;
      Iconname   : String;
      Can_Rename : Boolean;
      Branches   : Branches_Array);
   --  Gather the results of the branches list for the current VCS

   type Tooltips_Visitor is new Task_Visitor with record
      Label    : Gtk_Label;
   end record;
   overriding procedure On_Tooltip
     (Self     : not null access Tooltips_Visitor;
      Text     : String);
   overriding procedure Free (Self : in out Tooltips_Visitor);

   type On_Active_VCS_Changed is new Simple_Hooks_Function with null record;
   overriding procedure Execute
     (Self   : On_Active_VCS_Changed;
      Kernel : not null access Kernel_Handle_Record'Class);

   type On_VCS_Refresh is new Vcs_Refresh_Hooks_Function with null record;
   overriding procedure Execute
     (Self          : On_VCS_Refresh;
      Kernel        : not null access Kernel_Handle_Record'Class;
      Is_File_Saved : Boolean);

   type Has_Selected_Branch_Filter is
     new Action_Filter_Record with null record;
   overriding function Filter_Matches_Primitive
     (Self    : access Has_Selected_Branch_Filter;
      Context : Selection_Context) return Boolean;

   type Select_Branch is new Interactive_Command with null record;
   overriding function Execute
     (Command : access Select_Branch;
      Context : Interactive_Command_Context) return Command_Return_Type;
   --  Unstage the file described in the context.

   type Add_Branch is new Interactive_Command with null record;
   overriding function Execute
     (Command : access Add_Branch;
      Context : Interactive_Command_Context) return Command_Return_Type;

   type Delete_Branch is new Interactive_Command with null record;
   overriding function Execute
     (Command : access Delete_Branch;
      Context : Interactive_Command_Context) return Command_Return_Type;

   type Rename_Command is new Interactive_Command with null record;
   overriding function Execute
     (Command : access Rename_Command;
      Context : Interactive_Command_Context) return Command_Return_Type;
   --  Rename the selected branch

   type Branches_Tooltips is new Tooltips.Tooltips with record
      View   : access Branches_View_Record'Class;
   end record;
   overriding function Create_Contents
     (Self     : not null access Branches_Tooltips;
      Widget   : not null access Gtk.Widget.Gtk_Widget_Record'Class;
      X, Y     : Glib.Gint) return Gtk.Widget.Gtk_Widget;

   function Category_From_Node
     (Self       : not null access Branches_Tree_Record'Class;
      Store_Iter : Gtk_Tree_Iter) return String;
   --  Return the name of the top-level node that contains Store_Iter

   procedure On_Multipress
     (Self    : access Glib.Object.GObject_Record'Class;
      N_Press : Gint;
      X, Y    : Gdouble);
   --  Called every time a row is clicked

   procedure On_Longpress
     (Self    : access Glib.Object.GObject_Record'Class;
      X, Y    : Gdouble);
   --  Called to rename current entry

   procedure Clear (Self : not null access Branches_View_Record'Class);
   --  Clear the view

   procedure On_Destroyed (View : access Gtk_Widget_Record'Class);
   --  Called when the view is destroyed

   procedure Execute_Action_On_Selected_Lines
     (Context : Interactive_Command_Context;
      Action  : Branch_Action);
   --  Perform an action on the select lines

   ----------------------------
   -- Expansion_Id_From_Node --
   ----------------------------

   function Expansion_Id_From_Node
     (Self       : not null access Branches_Tree_Record'Class;
      Store_Iter : Gtk_Tree_Iter) return String
   is
      Id : constant String := Self.Model.Get_String (Store_Iter, Column_Id);
   begin
      if Id = "" then   --  a category
         return Category_Id_Prefix
           & Self.Model.Get_String (Store_Iter, Column_Name);
      else
         return Id;
      end if;
   end Expansion_Id_From_Node;

   ------------------------------
   -- Filter_Matches_Primitive --
   ------------------------------

   overriding function Filter_Matches_Primitive
     (Self    : access Has_Selected_Branch_Filter;
      Context : Selection_Context) return Boolean
   is
      pragma Unreferenced (Self);
      View : Branches_View;
      Tree : Branches_Tree;
      Filter_Iter : Gtk_Tree_Iter;
      Model       : Gtk_Tree_Model;
   begin
      if Module_ID (Get_Creator (Context)) /= Branches_Views.Get_Module then
         return False;
      end if;

      View := Branches_Views.Retrieve_View (Get_Kernel (Context));
      if View /= null then
         Tree := Branches_Tree (View.Tree);
         Tree.Get_Selection.Get_Selected (Model => Model, Iter => Filter_Iter);
         return Filter_Iter /= Null_Iter;
      end if;

      return False;
   end Filter_Matches_Primitive;

   -----------------
   -- Create_Menu --
   -----------------

   overriding procedure Create_Menu
     (View    : not null access Branches_View_Record;
      Menu    : not null access Gtk.Menu.Gtk_Menu_Record'Class)
   is
   begin
      Append_Menu (Menu, View.Kernel, Show_Ellipsis);
   end Create_Menu;

   ---------------------
   -- Create_Category --
   ---------------------

   function Create_Category
     (Self  : not null access Branches_View_Record'Class;
      Name  : String) return Gtk_Tree_Iter
   is
      Tree : constant Branches_Tree := Branches_Tree (Self.Tree);
      C    : constant Path_Maps.Cursor := Tree.Categories.Find
        (To_Lower (Name));
      Iter : Gtk_Tree_Iter;
      Path : Gtk_Tree_Path;
      V    : Glib.Values.GValue_Array (All_Columns);
   begin
      if Path_Maps.Has_Element (C) then
         Path   := Path_Maps.Element (C);
         return Tree.Model.Get_Iter (Path);
      end if;

      Self.Tree.Model.Append (Iter, Parent => Null_Iter);

      Init (V (Column_Foreground), Gdk.RGBA.Get_Type);
      Gdk.RGBA.Set_Value
        (V (Column_Foreground),
         Self.Get_Section_Title_Color);

      Init_Set_String (V (Column_Name), To_Upper (Name));
      Init_Set_String (V (Column_Emblem), "");
      Init_Set_Boolean (V (Column_Emblem_Visible), False);
      Init_Set_String (V (Column_Icon), "");
      Init_Set_Boolean (V (Column_Icon_Visible), False);
      Init_Set_String (V (Column_Id), "");
      Init_Set_Boolean (V (Column_Can_Rename), False);

      Set_All_And_Clear (Self.Tree.Model, Iter, V);

      Tree.Categories.Include (To_Lower (Name), Tree.Model.Get_Path (Iter));
      return Iter;
   end Create_Category;

   ------------------
   -- Create_Group --
   ------------------

   function Create_Group
     (Self      : not null access Branches_View_Record'Class;
      Icon_Name : String;
      Name      : String;
      Parent    : Gtk_Tree_Iter) return Gtk_Tree_Iter
   is
      Iter    : Gtk_Tree_Iter;
      V       : Glib.Values.GValue_Array (All_Columns);
   begin
      Iter := Self.Tree.Model.Children (Parent);
      while Iter /= Null_Iter loop
         if Self.Tree.Model.Get_String (Iter, Column_Name) = Name then
            return Iter;
         end if;
         Self.Tree.Model.Next (Iter);
      end loop;

      Self.Tree.Model.Append (Iter, Parent => Parent);

      Init (V (Column_Foreground), Gdk.RGBA.Get_Type);
      Gdk.RGBA.Set_Value
        (V (Column_Foreground), Default_Style.Get_Pref_Fg);

      Init_Set_String (V (Column_Name), Name);
      Init_Set_String (V (Column_Emblem), "");
      Init_Set_Boolean (V (Column_Emblem_Visible), False);
      Init_Set_String (V (Column_Icon), Icon_Name);
      Init_Set_Boolean (V (Column_Icon_Visible), Icon_Name /= "");
      Init_Set_Boolean (V (Column_Can_Rename), False);
      Init_Set_String (V (Column_Id), "");

      Set_All_And_Clear (Self.Tree.Model, Iter, V);
      return Iter;
   end Create_Group;

   -----------------
   -- Create_Node --
   -----------------

   procedure Create_Node
     (Self       : not null access Branches_View_Record'Class;
      Category   : Gtk_Tree_Iter;
      Icon_Name  : String;
      Info       : Branch_Info;
      Can_Rename : Boolean)
   is
      Parent  : Gtk_Tree_Iter := Category;
      Iter    : Gtk_Tree_Iter;
      V       : Glib.Values.GValue_Array (All_Columns);
      First, Last : Natural := Info.Name'First;

   begin
      if Info.Name (First) = '"'
        and then Info.Name (Info.Name'Last) = '"'
      then
         First := Info.Name'First + 1;
         Last  := Info.Name'Last;

      else
         while Last <= Info.Name'Last loop
            exit when Info.Name (Last) = '(';
            if Info.Name (Last) = '/' then
               Parent := Create_Group
                 (Self, Icon_Name, Info.Name (First .. Last - 1), Parent);
               First := Last + 1;
            end if;
            Last := Last + 1;
         end loop;
         Last := Info.Name'Last + 1;
      end if;

      Self.Tree.Model.Append (Iter, Parent => Parent);

      Init (V (Column_Foreground), Gdk.RGBA.Get_Type);
      Init_Set_String
         (V (Column_Name), Escape_Text (Info.Name (First .. Last - 1)));

      if Info.Is_Current then
         Gdk.RGBA.Set_Value (V (Column_Foreground), Emblem_Color);
      else
         Gdk.RGBA.Set_Value (V (Column_Foreground), Default_Style.Get_Pref_Fg);
      end if;

      Init_Set_String (V (Column_Emblem), Escape_Text (Info.Emblem.all));
      Init_Set_Boolean (V (Column_Emblem_Visible), Info.Emblem.all /= "");
      Init_Set_String (V (Column_Icon), Icon_Name);
      Init_Set_Boolean (V (Column_Icon_Visible), Icon_Name /= "");
      Init_Set_String (V (Column_Id), Info.Id.all);
      Init_Set_Boolean (V (Column_Can_Rename), Can_Rename);

      Set_All_And_Clear (Self.Tree.Model, Iter, V);
   end Create_Node;

   -----------------
   -- On_Branches --
   -----------------

   overriding procedure On_Branches
     (Self       : not null access Branches_Visitor;
      Category   : String;
      Iconname   : String;
      Can_Rename : Boolean;
      Branches   : Branches_Array)
   is
      View : constant Branches_View :=
        Branches_Views.Retrieve_View (Self.Kernel);
      Cat   : Gtk_Tree_Iter;
      Dummy : Boolean;
   begin
      if View /= null then
         Cat := Create_Category (View, Category);

         for B of Branches loop
            Create_Node (View, Cat, Iconname, B, Can_Rename);
         end loop;

         --  Restore the expansion immediately, so that newly inserted nodes
         --  have their original expansion. Do not force a collapse though,
         --  in case the user has already started manipulating the view.
         Branches_Expansion.Set_Expansion_Status
            (Branches_Tree (View.Tree), Self.Expansion,
             Collapse_All_First => False);
      end if;
   end On_Branches;

   -----------
   -- Clear --
   -----------

   procedure Clear (Self : not null access Branches_View_Record'Class) is
      Tree : constant Branches_Tree := Branches_Tree (Self.Tree);
   begin
      for C of Tree.Categories loop
         Path_Free (C);
      end loop;
      Tree.Categories.Clear;
      Tree.Model.Clear;
   end Clear;

   ------------------
   -- On_Destroyed --
   ------------------

   procedure On_Destroyed (View : access Gtk_Widget_Record'Class) is
   begin
      Clear (Branches_View (View));
   end On_Destroyed;

   -------------
   -- Execute --
   -------------

   overriding procedure Execute
     (Self          : On_VCS_Refresh;
      Kernel        : not null access Kernel_Handle_Record'Class;
      Is_File_Saved : Boolean)
   is
      pragma Unreferenced (Self, Is_File_Saved);
      View : constant Branches_View := Branches_Views.Retrieve_View (Kernel);
   begin
      if View /= null then
         Refresh (View);
      end if;
   end Execute;

   -------------
   -- Execute --
   -------------

   overriding procedure Execute
     (Self   : On_Active_VCS_Changed;
      Kernel : not null access Kernel_Handle_Record'Class)
   is
      pragma Unreferenced (Self);
      V    : constant Branches_View := Branches_Views.Retrieve_View (Kernel);
   begin
      if V /= null then
         Refresh (V);
      end if;
   end Execute;

   -------------
   -- Refresh --
   -------------

   overriding procedure Refresh
     (Self : not null access Branches_View_Record)
   is
      VCS     : constant VCS_Engine_Access := Active_VCS (Self.Kernel);
      Visitor : access Branches_Visitor;
   begin
      if VCS /= null then
         Visitor := new Branches_Visitor'
           (Task_Visitor with
            Kernel      => Self.Kernel,
            Expansion   => <>);

         --  Save expansion, but do not detach from view, so that the view is
         --  filled as information is discovered (querying data from Gerrit,
         --  for instance, might take a while).
         Branches_Expansion.Get_Expansion_Status
            (Branches_Tree (Self.Tree),
             Visitor.Expansion,
             Save_Scrolling => False);

         --  By default, BRANCHES is expanded
         if Self.Tree.Model.N_Children (Null_Iter) = 0 then
            Branches_Expansion.Set_Expanded
              (Visitor.Expansion, Category_Id_Prefix & "BRANCHES", True);
         end if;

         Clear (Self);
         VCS.Queue_Branches (Visitor);
      else
         Clear (Self);
      end if;
   end Refresh;

   ----------------------------
   -- On_Preferences_Changed --
   ----------------------------

   overriding procedure On_Preferences_Changed
     (Self    : not null access Branches_View_Record;
      Pref    : Preference)
   is
      Tree   : constant Branches_Tree := Branches_Tree (Self.Tree);
      Config : Branches_Config;
   begin
      Base_VCS_View_Record (Self.all).On_Preferences_Changed (Pref);
      Set_Font_And_Colors (Self.Tree, Fixed_Font => False, Pref => Pref);

      Config :=
        (Initialized      => True);

      if Config /= Tree.Config or else Pref = Preference (Default_Style) then
         Tree.Config := Config;
         Self.Refresh;
      end if;
   end On_Preferences_Changed;

   ------------------------
   -- Category_From_Node --
   ------------------------

   function Category_From_Node
     (Self       : not null access Branches_Tree_Record'Class;
      Store_Iter : Gtk_Tree_Iter) return String
   is
      Iter : Gtk_Tree_Iter := Self.Model.Parent (Store_Iter);
      P    : Gtk_Tree_Iter;
   begin
      if Iter = Null_Iter then
         --  Return the node itself (it will have a null id)
         return Self.Model.Get_String (Store_Iter, Column_Name);
      else
         loop
            P := Self.Model.Parent (Iter);
            exit when P = Null_Iter;
            Iter := P;
         end loop;
         return Self.Model.Get_String (Iter, Column_Name);
      end if;
   end Category_From_Node;

   -------------------
   -- On_Multipress --
   -------------------

   procedure On_Multipress
     (Self    : access Glib.Object.GObject_Record'Class;
      N_Press : Gint;
      X, Y    : Gdouble)
   is
      View           : constant Branches_View := Branches_View (Self);
      Tree           : constant Branches_Tree := Branches_Tree (View.Tree);
      Filter_Path    : Gtk_Tree_Path;
      Column         : Gtk_Tree_View_Column;
      Success        : Boolean;
      Cell_X, Cell_Y : Gint;
   begin
      if N_Press = 2 then
         Tree.Get_Path_At_Pos
           (Gint (X), Gint (Y), Filter_Path,
            Column, Cell_X, Cell_Y, Success);
         if Success then
            --  Select the row that was clicked
            Tree.Set_Cursor (Filter_Path, null, Start_Editing => False);

            declare
               Iter : constant Gtk_Tree_Iter :=
                 Tree.Get_Store_Iter_For_Filter_Path (Filter_Path);
               Id : constant String := Tree.Model.Get_String (Iter, Column_Id);
            begin
               if Id /= "" then
                  Active_VCS (View.Kernel).Queue_Action_On_Branch
                    (Visitor => Refresh_On_Terminate (View.Kernel),
                     Action   => Action_Double_Click,
                     Category => Category_From_Node (Tree, Iter),
                     Id       => Id);
               end if;
            end;

            Path_Free (Filter_Path);
            View.Multipress.Set_State (Event_Sequence_Claimed);
         end if;
      end if;
   end On_Multipress;

   ------------------
   -- On_Longpress --
   ------------------

   procedure On_Longpress
     (Self    : access Glib.Object.GObject_Record'Class;
      X, Y    : Gdouble)
   is
      View        : constant Branches_View := Branches_View (Self);
      Filter_Iter : Gtk_Tree_Iter;
      Col         : Gtk_Tree_View_Column;
   begin
      Coordinates_For_Event (View.Tree, X, Y, Filter_Iter, Col);
      if Filter_Iter /= Null_Iter then
         View.Tree.Start_Editing
           (Render     => Branches_Tree (View.Tree).Name_Render,
            Store_Iter => View.Tree.Convert_To_Store_Iter (Filter_Iter));
         View.Longpress.Set_State (Event_Sequence_Claimed);
      end if;
   end On_Longpress;

   --------------------------------------
   -- Execute_Action_On_Selected_Lines --
   --------------------------------------

   procedure Execute_Action_On_Selected_Lines
     (Context : Interactive_Command_Context;
      Action  : Branch_Action)
   is
      Kernel : constant Kernel_Handle := Get_Kernel (Context.Context);
      View   : constant Branches_View := Branches_Views.Retrieve_View (Kernel);
      Tree        : Branches_Tree;
      Store_Iter  : Gtk_Tree_Iter;
      Model       : Gtk_Tree_Model;
   begin
      if View /= null then
         Tree := Branches_Tree (View.Tree);
         Tree.Get_Selection.Get_Selected (Model => Model, Iter => Store_Iter);
         Store_Iter := Tree.Convert_To_Store_Iter (Store_Iter);
         if Store_Iter /= Null_Iter then
            Active_VCS (Kernel).Queue_Action_On_Branch
              (Visitor  => Refresh_On_Terminate (Kernel),
               Action   => Action,
               Category => Category_From_Node (Tree, Store_Iter),
               Id       => Tree.Model.Get_String (Store_Iter, Column_Id));
         end if;
      end if;
   end Execute_Action_On_Selected_Lines;

   -------------
   -- Execute --
   -------------

   overriding function Execute
     (Command : access Select_Branch;
      Context : Interactive_Command_Context) return Command_Return_Type
   is
      pragma Unreferenced (Command);
   begin
      Execute_Action_On_Selected_Lines (Context, Action_Double_Click);
      return Success;
   end Execute;

   -------------
   -- Execute --
   -------------

   overriding function Execute
     (Command : access Add_Branch;
      Context : Interactive_Command_Context) return Command_Return_Type
   is
      pragma Unreferenced (Command);
   begin
      Execute_Action_On_Selected_Lines (Context, Action_Add);
      return Success;
   end Execute;

   -------------
   -- Execute --
   -------------

   overriding function Execute
     (Command : access Delete_Branch;
      Context : Interactive_Command_Context) return Command_Return_Type
   is
      pragma Unreferenced (Command);
   begin
      Execute_Action_On_Selected_Lines (Context, Action_Remove);
      return Success;
   end Execute;

   ---------------
   -- On_Edited --
   ---------------

   overriding procedure On_Edited
     (Self        : not null access Branches_Tree_Record;
      Store_Iter  : Gtk_Tree_Iter;
      View_Column : Edited_Column_Id;
      Text        : String)
   is
      pragma Unreferenced (View_Column);
   begin
      Active_VCS (Self.Kernel).Queue_Action_On_Branch
        (Visitor  => Refresh_On_Terminate (Self.Kernel),
         Action   => Action_Rename,
         Category => Category_From_Node (Self, Store_Iter),
         Id       => Self.Model.Get_String (Store_Iter, Column_Id),
         Text     => Text);
   end On_Edited;

   -------------
   -- Execute --
   -------------

   overriding function Execute
     (Command : access Rename_Command;
      Context : Interactive_Command_Context) return Command_Return_Type
   is
      pragma Unreferenced (Command);
      Kernel : constant Kernel_Handle := Get_Kernel (Context.Context);
      View   : constant Branches_View := Branches_Views.Retrieve_View (Kernel);
      Tree   : Branches_Tree;
      Store_Iter  : Gtk_Tree_Iter;
      Model       : Gtk_Tree_Model;
   begin
      if View /= null then
         Tree := Branches_Tree (View.Tree);
         Tree.Get_Selection.Get_Selected (Model => Model, Iter => Store_Iter);
         Store_Iter := Tree.Convert_To_Store_Iter (Store_Iter);
         if Store_Iter /= Null_Iter
           and then Tree.Model.Get_Boolean (Store_Iter, Column_Can_Rename)
         then
            Tree.Start_Editing
              (Render     => Tree.Name_Render,
               Store_Iter => Store_Iter);
         end if;
      end if;
      return Success;
   end Execute;

   ----------------
   -- On_Tooltip --
   ----------------

   overriding procedure On_Tooltip
     (Self     : not null access Tooltips_Visitor;
      Text     : String) is
   begin
      if not Self.Label.In_Destruction then
         Self.Label.Set_Text (Self.Label.Get_Text & ASCII.LF & Text);
      end if;
   end On_Tooltip;

   ----------
   -- Free --
   ----------

   overriding procedure Free (Self : in out Tooltips_Visitor) is
   begin
      Unref (Self.Label);
   end Free;

   ---------------------
   -- Create_Contents --
   ---------------------

   overriding function Create_Contents
     (Self     : not null access Branches_Tooltips;
      Widget   : not null access Gtk.Widget.Gtk_Widget_Record'Class;
      X, Y     : Glib.Gint) return Gtk.Widget.Gtk_Widget
   is
      pragma Unreferenced (Widget);
      Tree        : constant Branches_Tree := Branches_Tree (Self.View.Tree);
      Filter_Iter : Gtk_Tree_Iter;
      Iter        : Gtk_Tree_Iter;
      Area        : Gdk_Rectangle;
      Label       : Gtk_Label;
   begin
      Initialize_Tooltips (Tree, X, Y, Area, Filter_Iter);
      Iter := Tree.Convert_To_Store_Iter (Filter_Iter);
      if Iter /= Null_Iter then
         Self.Set_Tip_Area (Area);
         Gtk_New (Label, Tree.Model.Get_String (Iter, Column_Name));
         Label.Ref_Sink;
         Ref (Label);  --  owned by the visitor

         Active_VCS (Self.View.Kernel).Queue_Action_On_Branch
           (Visitor => new Tooltips_Visitor'(Task_Visitor with Label => Label),
            Action   => Action_Tooltip,
            Category => Category_From_Node (Tree, Iter),
            Id       => Tree.Model.Get_String (Iter, Column_Id));
      end if;
      return Gtk_Widget (Label);
   end Create_Contents;

   --------------------
   -- Filter_Changed --
   --------------------

   overriding procedure Filter_Changed
     (Self    : not null access Branches_View_Record;
      Pattern : in out GPS.Search.Search_Pattern_Access)
   is
   begin
      GPS.Search.Free (Branches_Tree (Self.Tree).User_Filter);
      Branches_Tree (Self.Tree).User_Filter := Pattern;
      Self.Tree.Refilter;
   end Filter_Changed;

   ----------------
   -- Is_Visible --
   ----------------

   overriding function Is_Visible
     (Self : not null access Branches_Tree_Record;
      Iter : Gtk.Tree_Model.Gtk_Tree_Iter) return Boolean
   is
      N : constant String := Self.Model.Get_String (Iter, Column_Name);
      D : constant String := Self.Model.Get_String (Iter, Column_Emblem);
   begin
      if Self.User_Filter = null then
         return True;
      else
         return Self.User_Filter.Start (N) /= GPS.Search.No_Match
           or else Self.User_Filter.Start (D) /= GPS.Search.No_Match;
      end if;
   end Is_Visible;

   ----------------
   -- Initialize --
   ----------------

   function Initialize
     (Self : access Branches_View_Record'Class) return Gtk_Widget
   is
      Scrolled : Gtk_Scrolled_Window;
      Col      : Gtk_Tree_View_Column;
      Dummy    : Gint;
      Pixbuf   : Gtk_Cell_Renderer_Pixbuf;
      Tooltip  : access Branches_Tooltips'Class;
   begin
      Initialize_Vbox (Self, Homogeneous => False);
      Self.On_Destroy (On_Destroyed'Access);

      Gtk_New (Scrolled);
      Self.Pack_Start (Scrolled, Expand => True, Fill => True);

      Self.Tree := new Branches_Tree_Record;
      Initialize
        (Self.Tree,
         (Column_Name           => GType_String,
          Column_Foreground     => Gdk.RGBA.Get_Type,
          Column_Emblem         => GType_String,
          Column_Emblem_Visible => GType_Boolean,
          Column_Icon           => GType_String,
          Column_Icon_Visible   => GType_Boolean,
          Column_Id             => GType_String,
          Column_Can_Rename     => GType_Boolean),
         Capability_Type  => Filtered,
         Set_Visible_Func => True);
      Self.Tree.Set_Headers_Visible (False);
      Self.Tree.Get_Selection.Set_Mode (Selection_Single);
      Scrolled.Add (Self.Tree);

      Gtk_New (Self.Text_Render);
      Gtk_New (Self.Emblem);
      Gtk_New (Pixbuf);

      Gtk_New (Col);
      Col.Set_Expand (True);
      Dummy := Self.Tree.Append_Column (Col);

      Col.Pack_Start (Pixbuf, False);
      Col.Add_Attribute (Pixbuf, "icon-name", Column_Icon);
      Col.Add_Attribute (Pixbuf, "visible", Column_Icon_Visible);

      Col.Pack_Start (Self.Text_Render, True);
      Col.Add_Attribute (Self.Text_Render, "markup", Column_Name);
      Col.Add_Attribute
         (Self.Text_Render, "foreground-rgba", Column_Foreground);

      Branches_Tree (Self.Tree).Name_Render := Self.Text_Render;
      Branches_Tree (Self.Tree).Kernel := Self.Kernel;

      Self.Tree.Model.Set_Sort_Column_Id (Column_Name, Sort_Ascending);

      Tooltip := new Branches_Tooltips;
      Tooltip.View := Self;
      Tooltip.Set_Tooltip (Self.Tree);

      Gtk_New (Col);
      Col.Set_Expand (False);
      Dummy := Self.Tree.Append_Column (Col);

      Col.Pack_Start (Self.Emblem, False);
      Col.Add_Attribute (Self.Emblem, "text", Column_Emblem);
      Col.Add_Attribute (Self.Emblem, "visible", Column_Emblem_Visible);
      Self.Emblem.Set_Alignment (1.0, 0.5);
      Set_Property (Self.Emblem, Foreground_Rgba_Property, Emblem_Color);

      Setup_Contextual_Menu (Self.Kernel, Self.Tree);

      Gtk_New (Self.Multipress, Widget => Self.Tree);
      Self.Multipress.On_Pressed (On_Multipress'Access, Slot => Self);
      Self.Multipress.Watch (Self);

      Gtk_New (Self.Longpress, Widget => Self.Tree);
      Self.Longpress.On_Pressed (On_Longpress'Access, Slot => Self);
      Self.Longpress.Watch (Self);

      return Gtk_Widget (Self.Tree);
   end Initialize;

   ---------------
   -- On_Create --
   ---------------

   overriding procedure On_Create
     (Self    : not null access Branches_View_Record;
      Child   : not null access GPS.Kernel.MDI.GPS_MDI_Child_Record'Class)
   is
   begin
      Base_VCS_View_Record (Self.all).On_Create (Child);  --  inherited
      Vcs_Active_Changed_Hook.Add (new On_Active_VCS_Changed, Watch => Self);
      Vcs_Refresh_Hook.Add (new On_VCS_Refresh, Watch => Self);
   end On_Create;

   ---------------------
   -- Register_Module --
   ---------------------

   procedure Register_Module
     (Kernel : not null access Kernel_Handle_Record'Class)
   is
      Has_Selected_Branch : constant Action_Filter :=
        new Has_Selected_Branch_Filter;
   begin
      Branches_Views.Register_Module (Kernel);

      Register_Action
        (Kernel, "vcs checkout branch",
         Description =>
           -("Perform an action on the selected line." & ASCII.LF
             & "The exact behavior depends on the specific type of entry"
             & " that was selected, for instance selecting a branch or a tag,"
             & " or applying stashed git changes." & ASCII.LF
             & "This is the same as double-clicking on a line, see tooltips"
             & " for a more detailed description of each action."),
         Command     => new Select_Branch,
         Icon_Name   => "vcs-branch-symbolic",
         Filter      => Has_Selected_Branch,
         Category    => "VCS2");

      Register_Action
        (Kernel, "vcs add branch",
         Description =>
           -("Create a new branch, tag,..." & ASCII.LF
             & "The exact behavior depends on the specific type of entry"
             & " that was selected. See tooltips for a more detailed"
             & " description of what will happen."),
         Command     => new Add_Branch,
         Icon_Name   => "gps-add-symbolic",
         Filter      => Has_Selected_Branch,
         Category    => "VCS2");

      Register_Action
        (Kernel, "vcs delete branch",
         Description =>
           -("Delete a branch, tag,..." & ASCII.LF
           & "The exact behavior depends on the specific type of entry"
           & " that was selected. See tooltips for a more detailed"
           & " description of what will happen."),
         Command     => new Delete_Branch,
         Icon_Name   => "gps-remove-symbolic",
         Filter      => Has_Selected_Branch,
         Category    => "VCS2");

      Register_Action
        (Kernel, "vcs rename branch",
         Description =>
           -("Rename a branch, tag,..." & ASCII.LF
           & "The exact behavior depends on the specific type of entry"
           & " that was selected. See tooltips for a more detailed"
           & " description of what will happen."),
         Command     => new Rename_Command,
         Icon_Name   => "gps-rename-symbolic",
         Filter      => Has_Selected_Branch,
         Category    => "VCS2");
   end Register_Module;

end VCS2.Branches;
