U621-016: Allow specifying browser's export page format

We now display a dialog allowing to choose the page format
when exporting a browser to a given PDF or PNG file.

Depends-On: I2d6c321ea97591d31f425bd148f2ed33b84a89a8
Change-Id: I23ccb8b7b6c4ad317f5c0c0ace182cdddc8af3a9

Author: Anthony Leonardo Gracio

browsers/src/browsers-canvas.adb

@@ -15,6 +15,7 @@
 -- of the license.                                                          --
 ------------------------------------------------------------------------------
 
+with Ada.Characters.Handling;
 with Ada.Containers.Indefinite_Hashed_Maps;
 with Ada.Strings.Hash;
 with GNATCOLL.JSON;                     use GNATCOLL.JSON;
@@ -37,7 +38,9 @@ with Gdk.RGBA;                          use Gdk.RGBA;
 with Gdk.Window;                        use Gdk.Window;
 
 with Gtk.Box;                           use Gtk.Box;
+with Gtk.Dialog;                        use Gtk.Dialog;
 with Gtk.Enums;                         use Gtk.Enums;
+with Gtk.GEntry;                        use Gtk.GEntry;
 with Gtk.Handlers;                      use Gtk.Handlers;
 with Gtk.Image;                         use Gtk.Image;
 with Gtk.Menu;                          use Gtk.Menu;
@@ -61,6 +64,7 @@ with Commands;                          use Commands;
 with Commands.Interactive;              use Commands.Interactive;
 with Generic_Views;                     use Generic_Views;
 with GPS.Core_Kernels;                  use GPS.Core_Kernels;
+with GPS.Dialogs;                       use GPS.Dialogs;
 with GPS.Intl;                          use GPS.Intl;
 with GPS.Kernel;                        use GPS.Kernel;
 with GPS.Kernel.Actions;                use GPS.Kernel.Actions;
@@ -863,23 +867,65 @@ package body Browsers.Canvas is
 
    begin
       declare
-         Name   : constant Virtual_File :=
-                    Select_File
-                      (Title             => -("Export Browser As " &
-                                                Description),
-                       Parent            => Get_Main_Window (Kernel),
-                       File_Pattern      => +("*" & Extension),
-                       Pattern_Name      => -Description,
-                       Default_Name      => +("gpsbrowser" & Extension),
-                       Use_Native_Dialog => Use_Native_Dialogs.Get_Pref,
-                       Kind              => Save_File,
-                       History           => Get_History (Kernel));
-         Success : Boolean;
+         Dialog : GPS_Dialog;
+         Name              : Virtual_File;
+         Page_Format_Combo : Combo_Box;
+         File_Ent          : Gtk_Entry;
+         Success           : Boolean;
+         Response          : Gtk_Response_Type;
+         P_Format          : Page_Format;
       begin
+         --  Create a dialog to select the page's format and a filename
+         GPS.Dialogs.Gtk_New
+           (Dialog,
+            Title  => -"Select page format and filename",
+            Flags  => Destroy_With_Parent or Modal,
+            Kernel => Kernel);
+         Dialog.Add_OK_Cancel;
+
+         --  Create a combo box with an entry to choose the page format
+         Page_Format_Combo := Dialog.Add_Combo
+           (Message => "Page format",
+            Key     => "browsers_page_format",
+            Tooltip => "Select the page format. You can use predefined "
+           & "formats (e.g: a4_portrait) via the combo box or specify "
+           & "a custom size with the following format: '<width>, <height>'");
+
+         --  Add the predefined page formats to the combo box
+         for P_Format in Predefined_Page_Format_Type loop
+            Page_Format_Combo.Add_Choice
+              (Ada.Characters.Handling.To_Lower
+                 (Predefined_Page_Format_Type'Image (P_Format)));
+         end loop;
+
+         --  Create the filename selection entry
+         File_Ent := Dialog.Add_File_Selection_Entry
+           (Message      => "Select file",
+            Key          => Histories.History_Key
+              ("browsers_export_filename_" & Extension),
+            File_Pattern => "*" & Extension,
+            Pattern_Name => Description,
+            Default_Name => "gpsbrowser" & Extension,
+            Kind         => Save_File);
+
+         --  Show the dialog
+         Dialog.Show_All;
+         Response := Dialog.Run;
+
+         if Response /= Gtk_Response_OK then
+            Dialog.Destroy;
+            return False;
+         end if;
+
+         --  The user pressed 'Ok': create the file if the filename is correct
+
+         Name := Create_From_UTF8 (File_Ent.Get_Text);
+         P_Format := To_Page_Format (Page_Format_Combo.Get_Text);
+
          if Name /= GNATCOLL.VFS.No_File then
             Success := Data.Browser.View.Export
               (Filename          => Name.Display_Full_Name,
-               Page              => A4_Landscape,
+               Page              => P_Format,
                Format            => Data.Format,
                Visible_Area_Only => not Data.Whole);
 
@@ -889,6 +935,8 @@ package body Browsers.Canvas is
                   Mode => GPS.Kernel.Error);
             end if;
          end if;
+
+         Dialog.Destroy;
       end;
 
       return False;

browsers/src/browsers-scripts.adb

@@ -16,7 +16,6 @@
 ------------------------------------------------------------------------------
 
 with Ada.Characters.Handling;   use Ada.Characters.Handling;
-with Ada.Strings.Fixed;         use Ada.Strings.Fixed;
 with Browsers.Canvas;           use Browsers.Canvas;
 with Cairo.Pattern;             use Cairo, Cairo.Pattern;
 with Glib;                      use Glib;
@@ -186,7 +185,7 @@ package body Browsers.Scripts is
       Position           => Position_Automatic,
       Group              => Group_Default,
       Commands_Category  => "Browsers");
-   use Browser_Views;
+
    subtype Browser_View is Browser_Views.View_Access;
 
    function Call_Method
@@ -933,31 +932,10 @@ package body Browsers.Scripts is
          declare
             F      : constant String := Nth_Arg (Data, 3, "a4");
             Format : Page_Format;
-            Comma  : Integer;
             Filename : Virtual_File;
             Success  : Boolean;
          begin
-            if F = "" or else F = "a4" or else F = "a4_portrait" then
-               Format := A4_Portrait;
-            elsif F = "a4_landscape" then
-               Format := A4_Landscape;
-            elsif F = "a3" or else F = "a3_portrait" then
-               Format := A3_Portrait;
-            elsif F = "a3_landscape" then
-               Format := A3_Landscape;
-            elsif F = "letter" or else F = "letter_portrait" then
-               Format := Letter_Portrait;
-            elsif F = "letter_landscape" then
-               Format := Letter_Landscape;
-            elsif Is_Digit (F (F'First)) then
-               Comma := Index (F, ",");
-               Format.Width_In_Inches :=
-                 Gdouble'Value (F (F'First .. Comma - 1));
-               Format.Height_In_Inches :=
-                 Gdouble'Value (F (Comma + 1 .. F'Last));
-            else
-               Format := A4_Portrait;
-            end if;
+            Format := To_Page_Format (F);
 
             Filename := Nth_Arg (Data, 2);
             Success := View.Get_View.Export

browsers/src/browsers.adb

@@ -15,6 +15,9 @@
 -- of the license.                                                          --
 ------------------------------------------------------------------------------
 
+with Ada.Characters.Handling;  use Ada.Characters.Handling;
+with Ada.Strings.Fixed;        use Ada.Strings.Fixed;
+
 with Cairo;                    use Cairo;
 with GPS.Kernel.Preferences;   use GPS.Kernel.Preferences;
 with Gdk.RGBA;                 use Gdk.RGBA;
@@ -373,4 +376,39 @@ package body Browsers is
       return Self.Read_Only;
    end Is_Read_Only;
 
+   --------------------
+   -- To_Page_Format --
+   --------------------
+
+   function To_Page_Format (F : String) return Gtkada.Canvas_View.Page_Format
+   is
+      Format : Gtkada.Canvas_View.Page_Format;
+      Comma  : Integer;
+   begin
+
+      if F = "" or else F = "a4" or else F = "a4_portrait" then
+         Format := To_Page_Format (A4_Portrait);
+      elsif F = "a4_landscape" then
+         Format := To_Page_Format (A4_Landscape);
+      elsif F = "a3" or else F = "a3_portrait" then
+         Format := To_Page_Format (A3_Portrait);
+      elsif F = "a3_landscape" then
+         Format := To_Page_Format (A3_Landscape);
+      elsif F = "letter" or else F = "letter_portrait" then
+         Format := To_Page_Format (Letter_Portrait);
+      elsif F = "letter_landscape" then
+         Format := To_Page_Format (Letter_Landscape);
+      elsif Is_Digit (F (F'First)) then
+         Comma := Index (F, ",");
+         Format.Width_In_Inches :=
+           Gdouble'Value (F (F'First .. Comma - 1));
+         Format.Height_In_Inches :=
+           Gdouble'Value (F (Comma + 1 .. F'Last));
+      else
+         Format := To_Page_Format (A4_Portrait);
+      end if;
+
+      return Format;
+   end To_Page_Format;
+
 end Browsers;

browsers/src/browsers.ads

@@ -171,6 +171,11 @@ package Browsers is
    --  to the desktop.
    --  You will also need to override the browser's Load_From_ML
 
+   function To_Page_Format (F : String) return Gtkada.Canvas_View.Page_Format;
+   --  Convert of "a4", "a4_portrait", "a4_landscape", or similar variants
+   --  with "a3" and "letter". It can also be a string "width,height"
+   --  where the size is given in inches.
+
 private
 
    type GPS_Canvas_View_Record is new Gtkada.Canvas_View.Canvas_View_Record