Split Excel_Format into 3 constructors (#9308)

Splitting the `Excel_Format` into 3 constructors.

Author: radeusgd

distribution/lib/Standard/Base/0.0.0-dev/src/Data.enso

@@ -57,10 +57,9 @@ from project.System.File_Format import Auto_Detect, File_Format
      Read the sheet named `Dates` from an XLS and convert it to a table.
 
          from Standard.Table import all
-         from Standard.Table import Excel, Worksheet
          import Standard.Examples
 
-         example_xls_to_table = Data.read Examples.xls (Excel (Worksheet 'Dates'))
+         example_xls_to_table = Data.read Examples.xls (Excel_Format.Sheet 'Dates')
 @path Text_Input
 @format File_Format.default_widget
 read : Text | File -> File_Format -> Problem_Behavior -> Any ! File_Error

distribution/lib/Standard/Base/0.0.0-dev/src/Data/XML/XML_Format.enso

@@ -1,14 +1,17 @@
 import project.Any.Any
 import project.Data.Text.Text
+import project.Data.Vector.Vector
 import project.Data.XML.XML_Document
 import project.Errors.Problem_Behavior.Problem_Behavior
+import project.Meta
 import project.Network.URI.URI
 import project.Nothing.Nothing
 import project.System.File.File
 import project.System.File.Generic.Writable_File.Writable_File
 import project.System.File_Format_Metadata.File_Format_Metadata
 import project.System.Input_Stream.Input_Stream
 from project.Data.Text.Extensions import all
+from project.Metadata.Choice import Option
 
 ## A `File_Format` for reading and writing XML files.
 type XML_Format
@@ -35,6 +38,11 @@ type XML_Format
         _ = [file]
         Nothing
 
+
+    ## PRIVATE
+    get_dropdown_options : Vector Option
+    get_dropdown_options = [Option "XML" (Meta.get_qualified_type_name XML_Format)]
+
     ## PRIVATE
        Implements the `File.read` for this `File_Format`
     read : File -> Problem_Behavior -> Any

distribution/lib/Standard/Base/0.0.0-dev/src/Enso_Cloud/Data_Link.enso

@@ -38,6 +38,11 @@ type Data_Link_Format
         _ = file
         Nothing
 
+    ## PRIVATE
+       We currently don't display data-link as a specific format.
+       It relies on `Auto_Detect`.
+    get_dropdown_options = []
+
     ## PRIVATE
        Implements the `File.read` for this `File_Format`
     read : File -> Problem_Behavior -> Any

distribution/lib/Standard/Base/0.0.0-dev/src/System/File.enso

@@ -277,10 +277,9 @@ type File
          Read the sheet named `Dates` from an XLS and convert it to a table.
 
              from Standard.Table import all
-             from Standard.Table import Excel, Worksheet
              import Standard.Examples
 
-             example_xls_to_table = Examples.xls.read (Excel (Worksheet 'Dates'))
+             example_xls_to_table = Examples.xls.read (Excel_Format.Sheet 'Dates')
     @format File_Format.default_widget
     read : File_Format -> Problem_Behavior -> Any ! File_Error
     read self format=Auto_Detect (on_problems=Problem_Behavior.Report_Warning) =

distribution/lib/Standard/Base/0.0.0-dev/src/System/File_Format.enso

@@ -89,27 +89,12 @@ type File_Format
         _ = [file, on_problems]
         Unimplemented.throw "This is an interface only."
 
-    ## PRIVATE
-       Create the constructor code for a File_Format type.
-    constructor_code : Any -> Text
-    constructor_code type_obj =
-        ## Workaround for JSON and Auto_Detect
-        case type_obj of
-            JSON_Format -> "JSON_Format"
-            Auto_Detect -> "Auto_Detect"
-            _ ->
-                type_name = Meta.get_qualified_type_name type_obj
-                ctors = Meta.meta type_obj . constructors
-                is_singleton_type = ctors.length == 0
-                if is_singleton_type then type_name else
-                    type_name + "." + ctors.first.name
-
     ## PRIVATE
     default_widget : Widget
     default_widget =
-        all_types = [Auto_Detect] + format_types
-        make_name type_obj = type_obj.to_text.replace "_Format" "" . replace "_" " "
-        Single_Choice display=Display.Always values=(all_types.map n->(Option (make_name n) (File_Format.constructor_code n)))
+        options = [Option "Auto Detect" "Auto_Detect"] +
+            format_types.flat_map .get_dropdown_options
+        Single_Choice display=Display.Always values=options
 
 ## A file format for plain text files.
 type Plain_Text_Format
@@ -144,6 +129,10 @@ type Plain_Text_Format
     for_file_write : Writable_File -> Plain_Text_Format | Nothing
     for_file_write file = Plain_Text_Format.for_read file
 
+    ## PRIVATE
+    get_dropdown_options : Vector Option
+    get_dropdown_options = [Option "Plain Text" (Meta.get_qualified_type_name Plain_Text_Format)+".Plain_Text"]
+
     ## PRIVATE
        Implements the `File.read` for this `File_Format`
     read : File -> Problem_Behavior -> Any
@@ -179,6 +168,10 @@ type Bytes
     for_file_write : Writable_File -> Bytes | Nothing
     for_file_write file = Bytes.for_read file
 
+    ## PRIVATE
+    get_dropdown_options : Vector Option
+    get_dropdown_options = [Option "Bytes" (Meta.get_qualified_type_name Bytes)]
+
     ## PRIVATE
        Implements the `File.read` for this `File_Format`
     read : File -> Problem_Behavior -> Any
@@ -214,6 +207,10 @@ type JSON_Format
     for_file_write : Writable_File -> JSON_Format | Nothing
     for_file_write file = JSON_Format.for_read file
 
+    ## PRIVATE
+    get_dropdown_options : Vector Option
+    get_dropdown_options = [Option "JSON" (Meta.get_qualified_type_name JSON_Format)]
+
     ## PRIVATE
        Implements the `File.read` for this `File_Format`
     read : File -> Problem_Behavior -> Any

distribution/lib/Standard/Database/0.0.0-dev/src/Connection/SQLite_Format.enso

@@ -2,6 +2,7 @@ from Standard.Base import all
 import Standard.Base.Errors.Illegal_Argument.Illegal_Argument
 import Standard.Base.System.File.Generic.Writable_File.Writable_File
 import Standard.Base.System.File_Format_Metadata.File_Format_Metadata
+from Standard.Base.Metadata.Choice import Option
 
 import project.Connection.Database
 import project.Connection.SQLite_Details.SQLite_Details
@@ -36,6 +37,10 @@ type SQLite_Format
             ".sqlite" -> SQLite_Format.For_File
             _ -> Nothing
 
+    ## PRIVATE
+    get_dropdown_options : Vector Option
+    get_dropdown_options = [Option "SQLite" (Meta.get_qualified_type_name SQLite_Format)+".For_File"]
+
     ## PRIVATE
        Implements the `File.read` for this `File_Format`
     read : File -> Problem_Behavior -> Any

distribution/lib/Standard/Image/0.0.0-dev/src/Image_File_Format.enso

@@ -2,6 +2,7 @@ from Standard.Base import all
 import Standard.Base.Errors.Illegal_Argument.Illegal_Argument
 import Standard.Base.System.File.Generic.Writable_File.Writable_File
 import Standard.Base.System.File_Format_Metadata.File_Format_Metadata
+from Standard.Base.Metadata.Choice import Option
 
 import project.Image.Image
 
@@ -26,6 +27,10 @@ type Image_File_Format
     for_file_write : Writable_File -> Image_File_Format | Nothing
     for_file_write file = Image_File_Format.for_read file
 
+    ## PRIVATE
+    get_dropdown_options : Vector Option
+    get_dropdown_options = [Option "Image" (Meta.get_qualified_type_name Image_File_Format)+".For_File"]
+
     ## PRIVATE
        Implements the `File.read` for this `File_Format`
     read : File -> Problem_Behavior -> Any

distribution/lib/Standard/Table/0.0.0-dev/src/Data/Table.enso

@@ -2646,9 +2646,9 @@ type Table
          Write a table to an XLSX file.
 
              import Standard.Examples
-             from Standard.Table import Excel
+             from Standard.Table import all
 
-             example_to_xlsx = Examples.inventory_table.write (enso_project.data / "example_xlsx_output.xlsx") Excel
+             example_to_xlsx = Examples.inventory_table.write (enso_project.data / "example_xlsx_output.xlsx") (Excel_Format.Sheet "MySheetName")
     @format Widget_Helpers.write_table_selector
     write : Writable_File -> File_Format -> Existing_File_Behavior -> Match_Columns -> Problem_Behavior -> File ! Column_Count_Mismatch | Illegal_Argument | File_Error
     write self path:Writable_File format=Auto_Detect on_existing_file=Existing_File_Behavior.Backup match_columns=Match_Columns.By_Name on_problems=Report_Warning =

distribution/lib/Standard/Table/0.0.0-dev/src/Delimited/Delimited_Format.enso

@@ -4,6 +4,7 @@ import Standard.Base.Network.HTTP.Response.Response
 import Standard.Base.System.File.Generic.Writable_File.Writable_File
 import Standard.Base.System.File_Format_Metadata.File_Format_Metadata
 import Standard.Base.System.Input_Stream.Input_Stream
+from Standard.Base.Metadata.Choice import Option
 from Standard.Base.Widget_Helpers import make_file_read_delimiter_selector
 
 import project.Data.Data_Formatter.Data_Formatter
@@ -82,6 +83,10 @@ type Delimited_Format
     for_file_write : Writable_File -> Delimited_Format | Nothing
     for_file_write file = Delimited_Format.for_read file
 
+    ## PRIVATE
+    get_dropdown_options : Vector Option
+    get_dropdown_options = [Option "Delimited" (Meta.get_qualified_type_name Delimited_Format)+".Delimited"]
+
     ## PRIVATE
        ADVANCED
        Implements the `File.read` for this `File_Format`

distribution/lib/Standard/Table/0.0.0-dev/src/Excel/Excel_Format.enso

@@ -1,12 +1,16 @@
 from Standard.Base import all
 import Standard.Base.Errors.Illegal_Argument.Illegal_Argument
+import Standard.Base.Metadata.Display
 import Standard.Base.System.File.Generic.Writable_File.Writable_File
 import Standard.Base.System.File_Format_Metadata.File_Format_Metadata
 import Standard.Base.System.Input_Stream.Input_Stream
+from Standard.Base.Metadata.Choice import Option
+from Standard.Base.Metadata.Widget import Text_Input, Numeric_Input
 
 import project.Data.Match_Columns.Match_Columns
 import project.Data.Table.Table
-import project.Excel.Excel_Section.Excel_Section
+import project.Excel.Excel_Range.Excel_Range
+import project.Internal.Excel_Section.Excel_Section
 import project.Excel.Excel_Workbook.Excel_Workbook
 import project.Internal.Excel_Reader
 import project.Internal.Excel_Writer
@@ -22,52 +26,87 @@ should_treat_as_xls_format xls_format file =
 
 ## Read the file to a `Table` from an Excel file
 type Excel_Format
-    ## Read Excels files into a Table or Vector.
+    ## Reads an Excel file as a connection to an `Excel_Workbook`.
 
        Arguments:
-       - section: The `Excel_Section` to read from the workbook.
-         This can be one of:
-         - `Workbook` - open the workbook as a connection.
-         - `Sheet_Names` - outputs a `Vector` of sheet names.
-         - `Range_Names` - outputs a `Vector` of range names.
-         - `Worksheet` - outputs a `Table` containing the specified sheet.
-         - `Cell_Range` - outputs a `Table` containing the specified range.
+       - xls_format:
+         If set to `True`, the file is read as an Excel 95-2003 format.
+         If set to `False`, the file is read as an Excel 2007+ format.
+         `Infer` will attempt to deduce this from the extension of the filename.
+       - default_sheet: The default sheet to use when writing a table to a file
+         with these format settings.
+    @default_sheet Text_Input
+    Workbook (xls_format : Boolean | Infer = Infer) (default_sheet : Text = "EnsoSheet")
+
+    ## Reads a sheet from an Excel file as a `Table`.
+
+       Arguments:
+       - sheet: The sheet number or name.
+       - headers: If set to `True`, the first row is used as column names. If
+         set to `False`, the column names are Excel column names. If set to
+         `Infer`, the process tries to infer if headers are present on the first
+          row. If the column names are not unique, numeric suffixes will be
+          appended to disambiguate them.
+       - skip_rows: The number of rows to skip before reading the data.
+       - row_limit: The maximum number of rows to read. If set to `Nothing`, all
+         rows are read.
+       - xls_format:
+         If set to `True`, the file is read as an Excel 95-2003 format.
+         If set to `False`, the file is read as an Excel 2007+ format.
+         `Infer` will attempt to deduce this from the extension of the filename.
+    @sheet (Text_Input display=Display.Always)
+    Sheet (sheet:(Integer|Text)=1) (headers:(Boolean|Infer)=Infer) (skip_rows:Integer=0) (row_limit:(Integer|Nothing)=Nothing) (xls_format:Boolean|Infer=Infer)
+
+    ## Reads a range from an Excel file as a `Table`.
+
+       Arguments:
+       - address: A name of a range or an Excel-style address (e.g. Sheet1!A1:B2).
        - headers: If set to `True`, the first row is used as column names. If
          set to `False`, the column names are Excel column names. If set to
          `Infer`, the process tries to infer if headers are present on the first
           row. If the column names are not unique, numeric suffixes will be
           appended to disambiguate them.
+       - skip_rows: The number of rows to skip before reading the data.
+       - row_limit: The maximum number of rows to read. If set to `Nothing`, all
+         rows are read.
        - xls_format:
          If set to `True`, the file is read as an Excel 95-2003 format.
          If set to `False`, the file is read as an Excel 2007+ format.
          `Infer` will attempt to deduce this from the extension of the filename.
-       - default_sheet: The default sheet to use if `section` is set to
-         `Excel_Section.Workbook`.
-    Excel (section:Excel_Section=Excel_Section.Workbook) (headers:(Boolean|Infer)=Infer) (xls_format:(Boolean|Infer)=Infer) (default_sheet:Text="EnsoSheet")
+    @address Text_Input
+    Range (address:(Text|Excel_Range)) (headers:(Boolean|Infer)=Infer) (skip_rows:Integer=0) (row_limit:(Integer|Nothing)=Nothing) (xls_format : Boolean | Infer = Infer)
 
     ## PRIVATE
        ADVANCED
        If the File_Format supports reading from the file, return a configured instance.
     for_read : File_Format_Metadata -> Excel_Format | Nothing
     for_read file:File_Format_Metadata =
         is_xls = xls_format_from_metadata file
-        is_xls.if_not_nothing <|
-            Excel_Format.Excel xls_format=is_xls
+        is_xls.if_not_nothing <| Excel_Format.Workbook xls_format=is_xls
 
     ## PRIVATE
        If this File_Format should be used for writing to that file, return a configured instance.
     for_file_write : Writable_File -> Excel_Format | Nothing
     for_file_write file = Excel_Format.for_read file
 
+    ## PRIVATE
+    get_dropdown_options : Vector Option
+    get_dropdown_options =
+        fqn = Meta.get_qualified_type_name Excel_Format
+        workbook = Option "Excel Workbook" fqn+".Workbook"
+        sheet = Option "Excel Sheet" fqn+".Sheet"
+        range = Option "Excel Range" fqn+".Range"
+        [workbook, sheet, range]
+
     ## PRIVATE
        ADVANCED
        Implements the `File.read` for this `File_Format`
     read : File -> Problem_Behavior -> Any
     read self file on_problems =
         format = should_treat_as_xls_format self.xls_format file
-        case self.section of
-            Excel_Section.Workbook -> Excel_Workbook.new file format self.headers
-            _ -> Excel_Reader.read_file file self.section self.headers on_problems format
+        case self of
+            Excel_Format.Workbook _ _ -> Excel_Workbook.new file format
+            _ -> Excel_Reader.read_file file (as_section self) on_problems format
 
     ## PRIVATE
        Implements decoding the format from a stream.
@@ -88,8 +127,10 @@ type Excel_Format
             Error.throw (Illegal_Argument.Error message)
 
         Excel_Reader.handle_bad_format_with_handler bad_format <|
-            workbook = Excel_Workbook.from_stream stream xls_format self.headers
-            workbook.read_section self.section
+            workbook = Excel_Workbook.from_stream stream xls_format
+            case self of
+                Excel_Format.Workbook _ _ -> workbook
+                _ -> workbook.read_section (as_section self)
 
     ## PRIVATE
        ADVANCED
@@ -114,13 +155,7 @@ type Excel_Format
     write_table : File -> Table -> Existing_File_Behavior -> Match_Columns -> Problem_Behavior -> File
     write_table self file table on_existing_file match_columns on_problems =
         format = should_treat_as_xls_format self.xls_format file
-
-        case self.section of
-            Excel_Section.Sheet_Names -> Error.throw (Illegal_Argument.Error "Sheet_Names cannot be used for `write`.")
-            Excel_Section.Range_Names -> Error.throw (Illegal_Argument.Error "Range_Names cannot be used for `write`.")
-            Excel_Section.Workbook ->
-                Excel_Writer.write_file file table on_existing_file (Excel_Section.Worksheet self.default_sheet) True match_columns on_problems format
-            _ -> Excel_Writer.write_file file table on_existing_file self.section self.headers match_columns on_problems format
+        Excel_Writer.write_file file table on_existing_file (as_section self) match_columns on_problems format
 
 ## PRIVATE
    This function returns:
@@ -142,3 +177,15 @@ xls_format_from_metadata (metadata : File_Format_Metadata) =
             ".xls" -> True
             ".xlt" -> True
             _ -> Nothing
+
+## PRIVATE
+   Converts this format to a corresponding `Excel_Section`.
+as_section (format : Excel_Format) -> Excel_Section = case format of
+    Excel_Format.Workbook _ default_sheet ->
+        ## This case is only used for when writing to the workbook.
+           This results in writing to the default sheet, and we always write headers (ignored with append).
+        Excel_Section.Worksheet default_sheet headers=True
+    Excel_Format.Sheet sheet headers skip_rows row_limit _ ->
+        Excel_Section.Worksheet sheet headers skip_rows row_limit
+    Excel_Format.Range address headers skip_rows row_limit _ ->
+        Excel_Section.Cell_Range address headers skip_rows row_limit