Binding for filename.H added

author: Jedidiah Barber <contact@jedbarber.id.au> 2024-12-10 20:47:53 +1300
committer: Jedidiah Barber <contact@jedbarber.id.au> 2024-12-10 22:31:22 +1300
commit: 24781de8bedb3bf4d12d7ec1d0307842e59a3f94 (patch)
tree: 26e4ab0fad00728adead6cb6626fe40fa7a31704 /doc
parent: 70d75e1f45bcee89b363677a161f022ecbffd1db (diff)
3 files changed, 312 insertions, 3 deletions
diff --git a/doc/filename.html b/doc/filename.html
new file mode 100644
index 0000000..a922359
--- /dev/null
+++ b/doc/filename.html
@@ -0,0 +1,304 @@
+<!DOCTYPE html>
+
+<html lang="en">
+  <head>
+    <meta charset="utf-8">
+    <title>Filename Binding Map</title>
+    <link href="map.css" rel="stylesheet">
+  </head>
+
+  <body>
+
+
+<h2>Filename Binding Map</h2>
+
+
+<a href="index.html">Back to Index</a>
+
+
+<table class="package">
+  <tr><th colspan="2">Package name</th></tr>
+
+  <tr>
+    <td>filename</td>
+    <td>FLTK.Filenames</td>
+  </tr>
+
+</table>
+
+
+
+<table class="type">
+  <tr><th colspan="2">Types</th></tr>
+
+  <tr>
+    <td>char *</td>
+    <td>Path_String</td>
+  </tr>
+
+  <tr>
+    <td>int</td>
+    <td>Comparison</td>
+  </tr>
+
+  <tr>
+    <td>Fl_File_Sort_F</td>
+    <td>Compare_Function</td>
+  </tr>
+
+  <tr>
+    <td>struct dirent ***</td>
+    <td>File_List</td>
+  </tr>
+
+</table>
+
+
+
+<table class="type">
+  <tr><th colspan="2">Errors</th></tr>
+
+  <tr>
+    <td>char * msg</td>
+    <td>Open_URI_Error</td>
+  </tr>
+
+</table>
+
+
+
+<table class="function">
+  <tr><th colspan="2">Attributes</th></tr>
+
+  <tr>
+<td><pre>
+#define FL_PATH_MAX 2048
+</pre></td>
+<td><pre>
+Max_Path_Length : constant Natural;
+</pre></td>
+  </tr>
+
+</table>
+
+
+
+<table class="function">
+  <tr><th colspan="2">Functions and Procedures</th></tr>
+
+  <tr>
+<td><pre>
+int fl_alphasort(struct dirent **, struct dirent **);
+</pre></td>
+<td><pre>
+function Alpha_Sort
+       (A, B : in String)
+    return Comparison;
+</pre></td>
+  </tr>
+
+  <tr>
+<td><pre>
+int fl_casealphasort(struct dirent **, struct dirent **);
+</pre></td>
+<td><pre>
+function Case_Alpha_Sort
+       (A, B : in String)
+    return Comparison;
+</pre></td>
+  </tr>
+
+  <tr>
+<td><pre>
+int fl_casenumericsort(struct dirent **, struct dirent **);
+</pre></td>
+<td><pre>
+function Case_Numeric_Sort
+       (A, B : in String)
+    return Comparison;
+</pre></td>
+  </tr>
+
+  <tr>
+<td><pre>
+void fl_decode_uri(char *uri);
+</pre></td>
+<td><pre>
+function Decode_URI
+       (URI : in Path_String)
+    return Path_String;
+</pre></td>
+  </tr>
+
+  <tr>
+<td><pre>
+int fl_filename_absolute(char *to, int tolen, const char *from);
+</pre></td>
+<td><pre>
+function Absolute
+       (Name : in Path_String)
+    return Path_String;
+
+function Absolute
+       (Name    : in     Path_String;
+        Changed :    out Boolean)
+    return Path_String;
+</pre></td>
+  </tr>
+
+  <tr>
+<td><pre>
+int fl_filename_expand(char *to, int tolen, const char *from);
+</pre></td>
+<td><pre>
+function Expand
+       (Name : in Path_String)
+    return Path_String;
+
+function Expand
+       (Name    : in     Path_String;
+        Changed :    out Boolean)
+    return Path_String;
+</pre></td>
+  </tr>
+
+  <tr>
+<td><pre>
+const char * fl_filename_ext(const char *buf);
+</pre></td>
+<td><pre>
+function Extension
+       (Name : in Path_String)
+    return Path_String;
+</pre></td>
+  </tr>
+
+  <tr>
+<td><pre>
+void fl_filename_free_list(struct dirent ***l, int n);
+</pre></td>
+<td>Automatically called when a File_List goes out of scope.</td>
+  </tr>
+
+  <tr>
+<td><pre>
+int fl_filename_isdir(const char *name);
+</pre></td>
+<td><pre>
+function Is_Directory
+       (Name : in Path_String)
+    return Boolean;
+</pre></td>
+  </tr>
+
+  <tr>
+<td><pre>
+int fl_filename_list(const char *d, struct dirent ***l,
+    Fl_File_Sort_F *s=fl_numericsort);
+</pre></td>
+<td><pre>
+function Get_Listing
+       (Name : in Path_String;
+        Sort : in not null Compare_Function :=
+            Numeric_Sort'Access)
+    return File_List;
+</pre></td>
+  </tr>
+
+  <tr>
+<td>Tracking of the return value of fl_filename_list must be done manually.</td>
+<td><pre>
+function Length
+       (This : in File_List)
+    return Natural;
+</pre></td>
+  </tr>
+
+  <tr>
+<td>Dereferencing of a dirent struct must be done manually.</td>
+<td><pre>
+function Item
+       (This  : in File_List;
+        Index : in Positive)
+    return Path_String
+with Pre => Index in 1 .. This.Length;
+</pre></td>
+  </tr>
+
+  <tr>
+<td><pre>
+int fl_filename_match(const char *name, const char *pattern);
+</pre></td>
+<td><pre>
+function Match
+       (Input, Pattern : in String)
+    return Boolean;
+</pre></td>
+  </tr>
+
+  <tr>
+<td><pre>
+const char * fl_filename_name(const char *filename);
+</pre></td>
+<td><pre>
+function Base_Name
+       (Name : in Path_String)
+    return Path_String;
+</pre></td>
+  </tr>
+
+  <tr>
+<td><pre>
+int fl_filename_relative(char *to, int tolen, const char *from);
+</pre></td>
+<td><pre>
+function Relative
+       (Name : in Path_String)
+    return Path_String;
+
+function Relative
+       (Name    : in     Path_String;
+        Changed :    out Boolean)
+    return Path_String;
+</pre></td>
+  </tr>
+
+  <tr>
+<td><pre>
+char * fl_filename_setext(char *to, int tolen, const char *ext);
+</pre></td>
+<td><pre>
+function Set_Extension
+       (Name   : in Path_String;
+        Suffix : in String)
+    return Path_String;
+</pre></td>
+  </tr>
+
+  <tr>
+<td><pre>
+int fl_numericsort(struct dirent **, struct dirent **);
+</pre></td>
+<td><pre>
+function Numeric_Sort
+       (A, B : in String)
+    return Comparison;
+</pre></td>
+  </tr>
+
+  <tr>
+<td><pre>
+int fl_open_uri(const char *uri, char *msg, int msglen);
+</pre></td>
+<td><pre>
+procedure Open_URI
+       (URI : in Path_String);
+</pre></td>
+  </tr>
+
+</table>
+
+
+  </body>
+</html>
+
diff --git a/doc/fl_file_chooser.html b/doc/fl_file_chooser.html
index f43989d..06dab72 100644
--- a/doc/fl_file_chooser.html
+++ b/doc/fl_file_chooser.html
@@ -295,7 +295,10 @@ procedure Set_Show_Label
 <td><pre>
 static Fl_File_Sort_F * sort = fl_numericsort;
 </pre></td>
-<td>TBA</td>
+<td><pre>
+Sort_Method : not null FLTK.Filenames.Compare_Function :=
+    FLTK.Filenames.Numeric_Sort'Access;
+</pre></td>
   </tr>
 
 </table>
@@ -687,14 +690,14 @@ procedure Set_Chooser_Kind
 <td><pre>
 void * user_data() const;
 </pre></td>
-<td>&nbsp;</td>
+<td>Not used in public API.</td>
   </tr>
 
   <tr>
 <td><pre>
 void user_data(void *d);
 </pre></td>
-<td>&nbsp;</td>
+<td>Not used in public API.</td>
   </tr>
 
   <tr>
diff --git a/doc/index.html b/doc/index.html
index 7e78aba..d58e2da 100644
--- a/doc/index.html
+++ b/doc/index.html
@@ -17,6 +17,7 @@
 
 <ul>
   <li><a href="fl.html">Enumerations</a></li>
+  <li><a href="filename.html">Filename</a></li>
   <li><a href="fl.html">Fl</a></li>
   <li><a href="fl_adjuster.html">Fl_Adjuster</a></li>
   <li><a href="fl_ask.html">Fl_Ask</a></li>
@@ -148,6 +149,7 @@
   <li><a href="fl.html">FLTK.Errors</a></li>
   <li><a href="fl.html">FLTK.Event</a></li>
   <li><a href="fl_file_chooser.html">FLTK.File_Choosers</a></li>
+  <li><a href="filename.html">FLTK.Filenames</a></li>
   <li><a href="fl_help_dialog.html">FLTK.Help_Dialogs</a></li>
   <li><a href="fl_image.html">FLTK.Images</a></li>
   <li><a href="fl_bitmap.html">FLTK.Images.Bitmaps</a></li>
author	Jedidiah Barber <contact@jedbarber.id.au>	2024-12-10 20:47:53 +1300
committer	Jedidiah Barber <contact@jedbarber.id.au>	2024-12-10 22:31:22 +1300
commit	24781de8bedb3bf4d12d7ec1d0307842e59a3f94 (patch)
tree	26e4ab0fad00728adead6cb6626fe40fa7a31704 /doc
parent	70d75e1f45bcee89b363677a161f022ecbffd1db (diff)