Document fl_numericsort() and fl_casenumericsort().

Note: These two functions are not yet UTF-8 aware. Results may be unexpected.

Possible test case: run test/file_chooser or any FLTK program with
Fl_File_Chooser. The default display order is determined by fl_numericsort():

  Fl_File_Chooser::sort = fl_numericsort;


git-svn-id: file:///fltk/svn/fltk/branches/branch-1.4@12738 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
This commit is contained in:
Albrecht Schlosser 2018-03-11 16:24:36 +00:00
parent d8d04bf772
commit 0b1fd7ee37

View File

@ -3,7 +3,7 @@
*
* Numeric sorting routine for the Fast Light Tool Kit (FLTK).
*
* Copyright 1998-2016 by Bill Spitzak and others.
* Copyright 1998-2018 by Bill Spitzak and others.
*
* This library is free software. Distribution and use rights are outlined in
* the file "COPYING" which should have been included with this file. If this
@ -21,9 +21,16 @@
#include <FL/platform_types.h>
#include <FL/filename.H>
/**
\file numericsort.c
*/
/*
* 'numericsort()' - Compare two directory entries, possibly with
* a case-insensitive comparison...
numericsort() - Compare two directory entries, possibly with a
case-insensitive comparison...
*FIXME* This is not UTF-8 aware -- particularly case-insensitive comparison.
*FIXME* If you fix it, don't forget to update the documentation below.
*/
static int numericsort(struct dirent **A, struct dirent **B, int cs) {
@ -47,7 +54,7 @@ static int numericsort(struct dirent **A, struct dirent **B, int cs) {
/* compare case-sensitive */
if ((ret = *a-*b)) break;
} else {
/* compare case-insensitve */
/* compare case-insensitive */
if ((ret = tolower(*a & 255)-tolower(*b & 255))) break;
}
@ -59,16 +66,57 @@ static int numericsort(struct dirent **A, struct dirent **B, int cs) {
else return (ret < 0) ? -1 : 1;
}
/*
* 'fl_casenumericsort()' - Compare directory entries with case-sensitivity.
/**
Compares directory entries alphanumerically (case-insensitive).
\note This comparison is not (yet) UTF-8 aware.
\todo Make comparison UTF-8 aware.
\see fl_numericsort()
*/
int fl_casenumericsort(struct dirent **A, struct dirent **B) {
return numericsort(A, B, 0);
}
/*
* 'fl_numericsort()' - Compare directory entries with case-sensitivity.
/**
Compares directory entries alphanumerically (case-sensitive).
Numbers are compared without sign, i.e. "-" is not taken as a sign of
following numerical values. The following list of files would be in
ascending order (examples are ASCII and numbers only for simplicity):
-# 1zzz.txt
-# 2xxx.txt
-# 19uuu.txt
-# 100aaa.txt
-# file1z.txt
-# file5a.txt
-# file5z.txt
-# file30z.txt
-# file200a.txt
-# temp+5.txt ('+' is lexically lower than '-')
-# temp-5.txt ('-' is not a sign)
-# temp-100.txt (100 is bigger than 5, no sign)
\param[in] A first directory entry
\param[in] B second directory entry
\returns comparison result (-1, 0, or +1)
\retval -1 A \< B
\retval 0 A == B
\retval +1 A \> B
\note This comparison is not (yet) UTF-8 aware:
- UTF-8 characters are compared according to their binary values.
- Locale settings may influence the result in unexpected ways.
- The latter is particularly true for fl_casenumericsort().
This may be changed in a future release.
\todo Make comparison UTF-8 aware.
\see fl_casenumericsort()
*/
int fl_numericsort(struct dirent **A, struct dirent **B) {