ref: bee35b5750748cf101a6924543e46ec3f9c783ba
dir: /DoConfig/fltk/src/Fl_File_Browser.cxx/
//
// "$Id$"
//
// Fl_File_Browser routines.
//
// Copyright 1999-2010 by Michael Sweet.
//
// 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
// file is missing or damaged, see the license at:
//
// http://www.fltk.org/COPYING.php
//
// Please report all bugs and problems on the following page:
//
// http://www.fltk.org/str.php
//
// Contents:
//
// Fl_File_Browser::full_height() - Return the height of the list.
// Fl_File_Browser::item_height() - Return the height of a list item.
// Fl_File_Browser::item_width() - Return the width of a list item.
// Fl_File_Browser::item_draw() - Draw a list item.
// Fl_File_Browser::Fl_File_Browser() - Create a Fl_File_Browser widget.
// Fl_File_Browser::load() - Load a directory into the browser.
// Fl_File_Browser::filter() - Set the filename filter.
//
//
// Include necessary header files...
//
#include <FL/Fl_File_Browser.H>
#include <FL/fl_draw.H>
#include <FL/filename.H>
#include <FL/Fl_Image.H> // icon
#include <stdio.h>
#include <stdlib.h>
#include "flstring.h"
#ifdef __CYGWIN__
# include <mntent.h>
#elif defined(WIN32)
# include <windows.h>
# include <direct.h>
// Apparently Borland C++ defines DIRECTORY in <direct.h>, which
// interfers with the Fl_File_Icon enumeration of the same name.
# ifdef DIRECTORY
# undef DIRECTORY
# endif // DIRECTORY
#endif // __CYGWIN__
#ifdef __EMX__
# define INCL_DOS
# define INCL_DOSMISC
# include <os2.h>
#endif // __EMX__
#if defined(__APPLE__)
# include <sys/param.h>
# include <sys/ucred.h>
# include <sys/mount.h>
#endif // __APPLE__
#if defined(_AIX)
extern "C" {
# include <sys/types.h>
# include <sys/vmount.h>
# include <sys/mntctl.h>
// Older AIX versions don't expose this prototype
int
mntctl(int, int, char *);
}
#endif // _AIX
#if defined(__NetBSD__)
extern "C" {
# include <sys/param.h> // For '__NetBSD_Version__' definition
# if defined(__NetBSD_Version__) && (__NetBSD_Version__ >= 300000000)
# include <sys/types.h>
# include <sys/statvfs.h>
# if defined(HAVE_PTHREAD) && defined(HAVE_PTHREAD_H)
# include <pthread.h>
# endif // HAVE_PTHREAD && HAVE_PTHREAD_H
# ifdef HAVE_PTHREAD
static pthread_mutex_t getvfsstat_mutex = PTHREAD_MUTEX_INITIALIZER;
# endif // HAVE_PTHREAD/
# endif // __NetBSD_Version__
}
#endif // __NetBSD__
//
// FL_BLINE definition from "Fl_Browser.cxx"...
//
#define SELECTED 1
#define NOTDISPLAYED 2
// TODO -- Warning: The definition of FL_BLINE here is a hack.
// Fl_File_Browser should not do this. PLEASE FIX.
// FL_BLINE should be private to Fl_Browser, and not re-defined here.
// For now, make sure this struct is precisely consistent with Fl_Browser.cxx.
//
struct FL_BLINE // data is in a linked list of these
{
FL_BLINE *prev; // Previous item in list
FL_BLINE *next; // Next item in list
void *data; // Pointer to data (function)
Fl_Image *icon; // Pointer to optional icon
short length; // sizeof(txt)-1, may be longer than string
char flags; // selected, displayed
char txt[1]; // start of allocated array
};
//
// 'Fl_File_Browser::full_height()' - Return the height of the list.
//
int // O - Height in pixels
Fl_File_Browser::full_height() const
{
int i, // Looping var
th; // Total height of list.
for (i = 0, th = 0; i < size(); i ++)
th += item_height(find_line(i));
return (th);
}
//
// 'Fl_File_Browser::item_height()' - Return the height of a list item.
//
int // O - Height in pixels
Fl_File_Browser::item_height(void *p) const // I - List item data
{
FL_BLINE *line; // Pointer to line
char *t; // Pointer into text
int height; // Width of line
int textheight; // Height of text
// Figure out the standard text height...
fl_font(textfont(), textsize());
textheight = fl_height();
// We always have at least 1 line...
height = textheight;
// Scan for newlines...
line = (FL_BLINE *)p;
if (line != NULL)
for (t = line->txt; *t != '\0'; t ++)
if (*t == '\n')
height += textheight;
// If we have enabled icons then add space for them...
if (Fl_File_Icon::first() != NULL && height < iconsize_)
height = iconsize_;
// Add space for the selection border..
height += 2;
// Return the height
return (height);
}
//
// 'Fl_File_Browser::item_width()' - Return the width of a list item.
//
int // O - Width in pixels
Fl_File_Browser::item_width(void *p) const // I - List item data
{
int i; // Looping var
FL_BLINE *line; // Pointer to line
char *t, // Pointer into text
*ptr, // Pointer into fragment
fragment[10240]; // Fragment of text
int width, // Width of line
tempwidth; // Width of fragment
int column; // Current column
const int *columns; // Columns
// Scan for newlines...
line = (FL_BLINE *)p;
columns = column_widths();
// Set the font and size...
if (line->txt[strlen(line->txt) - 1] == '/')
fl_font(textfont() | FL_BOLD, textsize());
else
fl_font(textfont(), textsize());
if (strchr(line->txt, '\n') == NULL &&
strchr(line->txt, column_char()) == NULL)
{
// Do a fast width calculation...
width = (int)fl_width(line->txt);
}
else
{
// More than 1 line or have columns; find the maximum width...
width = 0;
tempwidth = 0;
column = 0;
for (t = line->txt, ptr = fragment; *t != '\0'; t ++)
if (*t == '\n')
{
// Newline - nul terminate this fragment and get the width...
*ptr = '\0';
tempwidth += (int)fl_width(fragment);
// Update the max width as needed...
if (tempwidth > width)
width = tempwidth;
// Point back to the start of the fragment...
ptr = fragment;
tempwidth = 0;
column = 0;
}
else if (*t == column_char())
{
// Advance to the next column...
column ++;
if (columns)
{
for (i = 0, tempwidth = 0; i < column && columns[i]; i ++)
tempwidth += columns[i];
}
else
tempwidth = column * (int)(fl_height() * 0.6 * 8.0);
if (tempwidth > width)
width = tempwidth;
ptr = fragment;
}
else
*ptr++ = *t;
if (ptr > fragment)
{
// Nul terminate this fragment and get the width...
*ptr = '\0';
tempwidth += (int)fl_width(fragment);
// Update the max width as needed...
if (tempwidth > width)
width = tempwidth;
}
}
// If we have enabled icons then add space for them...
if (Fl_File_Icon::first() != NULL)
width += iconsize_ + 8;
// Add space for the selection border..
width += 2;
// Return the width
return (width);
}
//
// 'Fl_File_Browser::item_draw()' - Draw a list item.
//
void
Fl_File_Browser::item_draw(void *p, // I - List item data
int X, // I - Upper-lefthand X coordinate
int Y, // I - Upper-lefthand Y coordinate
int W, // I - Width of item
int) const // I - Height of item
{
int i; // Looping var
FL_BLINE *line; // Pointer to line
Fl_Color c; // Text color
char *t, // Pointer into text
*ptr, // Pointer into fragment
fragment[10240]; // Fragment of text
int width, // Width of line
height; // Height of line
int column; // Current column
const int *columns; // Columns
// Draw the list item text...
line = (FL_BLINE *)p;
if (line->txt[strlen(line->txt) - 1] == '/')
fl_font(textfont() | FL_BOLD, textsize());
else
fl_font(textfont(), textsize());
if (line->flags & SELECTED)
c = fl_contrast(textcolor(), selection_color());
else
c = textcolor();
if (Fl_File_Icon::first() == NULL)
{
// No icons, just draw the text...
X ++;
W -= 2;
}
else
{
// Draw the icon if it is set...
if (line->data)
((Fl_File_Icon *)line->data)->draw(X, Y, iconsize_, iconsize_,
(line->flags & SELECTED) ? FL_YELLOW :
FL_LIGHT2,
active_r());
// Draw the text offset to the right...
X += iconsize_ + 9;
W -= iconsize_ - 10;
// Center the text vertically...
height = fl_height();
for (t = line->txt; *t != '\0'; t ++)
if (*t == '\n')
height += fl_height();
if (height < iconsize_)
Y += (iconsize_ - height) / 2;
}
// Draw the text...
line = (FL_BLINE *)p;
columns = column_widths();
width = 0;
column = 0;
if (active_r())
fl_color(c);
else
fl_color(fl_inactive(c));
for (t = line->txt, ptr = fragment; *t != '\0'; t ++) {
if (*t == '\n') {
// Newline - nul terminate this fragment and draw it...
*ptr = '\0';
fl_draw(fragment, X + width, Y, W - width, fl_height(),
(Fl_Align)(FL_ALIGN_LEFT | FL_ALIGN_CLIP), 0, 0);
// Point back to the start of the fragment...
ptr = fragment;
width = 0;
Y += fl_height();
column = 0;
} else if (*t == column_char()) {
// Tab - nul terminate this fragment and draw it...
*ptr = '\0';
int cW = W - width; // Clip width...
if (columns) {
// Try clipping inside this column...
for (i = 0; i < column && columns[i]; i ++) { ; }
if (columns[i])
cW = columns[i];
}
fl_draw(fragment, X + width, Y, cW, fl_height(),
(Fl_Align)(FL_ALIGN_LEFT | FL_ALIGN_CLIP), 0, 0);
// Advance to the next column...
column ++;
if (columns) {
for (i = 0, width = 0; i < column && columns[i]; i ++)
width += columns[i];
}
else
width = column * (int)(fl_height() * 0.6 * 8.0);
ptr = fragment;
}
else
*ptr++ = *t;
}
if (ptr > fragment) {
// Nul terminate this fragment and draw it...
*ptr = '\0';
fl_draw(fragment, X + width, Y, W - width, fl_height(),
(Fl_Align)(FL_ALIGN_LEFT | FL_ALIGN_CLIP), 0, 0);
}
}
//
// 'Fl_File_Browser::Fl_File_Browser()' - Create a Fl_File_Browser widget.
//
Fl_File_Browser::Fl_File_Browser(int X, // I - Upper-lefthand X coordinate
int Y, // I - Upper-lefthand Y coordinate
int W, // I - Width in pixels
int H, // I - Height in pixels
const char *l) // I - Label text
: Fl_Browser(X, Y, W, H, l)
{
// Initialize the filter pattern, current directory, and icon size...
pattern_ = "*";
directory_ = "";
iconsize_ = (uchar)(3 * textsize() / 2);
filetype_ = FILES;
}
//
// 'Fl_File_Browser::load()' - Load a directory into the browser.
//
int // O - Number of files loaded
Fl_File_Browser::load(const char *directory,// I - Directory to load
Fl_File_Sort_F *sort) // I - Sort function to use
{
int i; // Looping var
int num_files; // Number of files in directory
int num_dirs; // Number of directories in list
char filename[4096]; // Current file
Fl_File_Icon *icon; // Icon to use
// printf("Fl_File_Browser::load(\"%s\")\n", directory);
clear();
directory_ = directory;
if (!directory)
return (0);
if (directory_[0] == '\0')
{
//
// No directory specified; for UNIX list all mount points. For DOS
// list all valid drive letters...
//
num_files = 0;
if ((icon = Fl_File_Icon::find("any", Fl_File_Icon::DEVICE)) == NULL)
icon = Fl_File_Icon::find("any", Fl_File_Icon::DIRECTORY);
#ifdef WIN32
# ifdef __CYGWIN__
//
// Cygwin provides an implementation of setmntent() to get the list
// of available drives...
//
FILE *m = setmntent("/-not-used-", "r");
struct mntent *p;
while ((p = getmntent (m)) != NULL) {
add(p->mnt_dir, icon);
num_files ++;
}
endmntent(m);
# else
//
// Normal WIN32 code uses drive bits...
//
DWORD drives; // Drive available bits
drives = GetLogicalDrives();
for (i = 'A'; i <= 'Z'; i ++, drives >>= 1)
if (drives & 1)
{
sprintf(filename, "%c:/", i);
if (i < 'C') // see also: GetDriveType and GetVolumeInformation in WIN32
add(filename, icon);
else
add(filename, icon);
num_files ++;
}
# endif // __CYGWIN__
#elif defined(__EMX__)
//
// OS/2 code uses drive bits...
//
ULONG curdrive; // Current drive
ULONG drives; // Drive available bits
int start = 3; // 'C' (MRS - dunno if this is correct!)
DosQueryCurrentDisk(&curdrive, &drives);
drives >>= start - 1;
for (i = 'A'; i <= 'Z'; i ++, drives >>= 1)
if (drives & 1)
{
sprintf(filename, "%c:/", i);
add(filename, icon);
num_files ++;
}
#elif defined(__APPLE__)
// MacOS X and Darwin use getfsstat() system call...
int numfs; // Number of file systems
struct statfs *fs; // Buffer for file system info
// We always have the root filesystem.
add("/", icon);
// Get the mounted filesystems...
numfs = getfsstat(NULL, 0, MNT_NOWAIT);
if (numfs > 0) {
// We have file systems, get them...
fs = new struct statfs[numfs];
getfsstat(fs, sizeof(struct statfs) * numfs, MNT_NOWAIT);
// Add filesystems to the list...
for (i = 0; i < numfs; i ++) {
// Ignore "/", "/dev", and "/.vol"...
if (fs[i].f_mntonname[1] && strcmp(fs[i].f_mntonname, "/dev") &&
strcmp(fs[i].f_mntonname, "/.vol")) {
snprintf(filename, sizeof(filename), "%s/", fs[i].f_mntonname);
add(filename, icon);
}
num_files ++;
}
// Free the memory used for the file system info array...
delete[] fs;
}
#elif defined(_AIX)
// AIX don't write the mounted filesystems to a file like '/etc/mnttab'.
// But reading the list of mounted filesystems from the kernel is possible:
// http://publib.boulder.ibm.com/infocenter/pseries/v5r3/topic/com.ibm.aix.basetechref/doc/basetrf1/mntctl.htm
int res = -1, len;
char *list = NULL, *name;
struct vmount *vp;
// We always have the root filesystem
add("/", icon);
// Get the required buffer size for the vmount structures
res = mntctl(MCTL_QUERY, sizeof(len), (char *) &len);
if (!res) {
// Allocate buffer ...
list = (char *) malloc((size_t) len);
if (NULL == list) {
res = -1;
} else {
// ... and read vmount structures from kernel
res = mntctl(MCTL_QUERY, len, list);
if (0 >= res) {
res = -1;
} else {
for (i = 0, vp = (struct vmount *) list; i < res; ++i) {
name = (char *) vp + vp->vmt_data[VMT_STUB].vmt_off;
strlcpy(filename, name, sizeof(filename));
// Skip the already added root filesystem
if (strcmp("/", filename) != 0) {
strlcat(filename, "/", sizeof(filename));
add(filename, icon);
}
vp = (struct vmount *) ((char *) vp + vp->vmt_length);
}
}
}
}
// Note: Executing 'free(NULL)' is allowed and simply do nothing
free((void *) list);
#elif defined(__NetBSD__) && defined(__NetBSD_Version__) \
&& (__NetBSD_Version__ >= 300000000)
// NetBSD don't write the mounted filesystems to a file like '/etc/mnttab'.
// Since NetBSD 3.0 the system call getvfsstat(2) has replaced getfsstat(2)
// that is used by getmntinfo(3):
// http://www.daemon-systems.org/man/getmntinfo.3.html
int res = -1;
struct statvfs *list;
// We always have the root filesystem
add("/", icon);
# ifdef HAVE_PTHREAD
// Lock mutex for thread safety
if (!pthread_mutex_lock(&getvfsstat_mutex)) {
# endif // HAVE_PTHREAD
// Get list of statvfs structures
res = getmntinfo(&list, ST_WAIT);
if(0 < res) {
for (i = 0; i < res; ++i) {
strlcpy(filename, list[i].f_mntonname, sizeof(filename));
// Skip the already added root filesystem
if (strcmp("/", filename) != 0) {
strlcat(filename, "/", sizeof(filename));
add(filename, icon);
}
}
} else {
res = -1;
}
# ifdef HAVE_PTHREAD
pthread_mutex_unlock(&getvfsstat_mutex);
}
# endif // HAVE_PTHREAD
#else
//
// UNIX code uses /etc/fstab or similar...
//
FILE *mtab; // /etc/mtab or /etc/mnttab file
char line[FL_PATH_MAX]; // Input line
//
// Open the file that contains a list of mounted filesystems...
//
mtab = fl_fopen("/etc/mnttab", "r"); // Fairly standard
if (mtab == NULL)
mtab = fl_fopen("/etc/mtab", "r"); // More standard
if (mtab == NULL)
mtab = fl_fopen("/etc/fstab", "r"); // Otherwise fallback to full list
if (mtab == NULL)
mtab = fl_fopen("/etc/vfstab", "r"); // Alternate full list file
if (mtab != NULL)
{
// We always have the root filesystem
add("/", icon);
num_files ++;
while (fgets(line, sizeof(line), mtab) != NULL)
{
if (line[0] == '#' || line[0] == '\n')
continue;
if (sscanf(line, "%*s%4095s", filename) != 1)
continue;
if (strcmp("/", filename) == 0) continue; // root was added before
// Add a trailing slash (except for the root filesystem)
strlcat(filename, "/", sizeof(filename));
// printf("Fl_File_Browser::load() - adding \"%s\" to list...\n", filename);
add(filename, icon);
num_files ++;
}
fclose(mtab);
} else {
// Every Unix has a root filesystem '/'.
// This last stage fallback ensures that the user don't get an empty
// window after requesting filesystem list.
add("/", icon);
}
#endif // WIN32 || __EMX__ || __APPLE__ || _AIX || ...
}
else
{
dirent **files; // Files in in directory
//
// Build the file list...
//
#if (defined(WIN32) && !defined(__CYGWIN__)) || defined(__EMX__)
strlcpy(filename, directory_, sizeof(filename));
i = (int) (strlen(filename) - 1);
if (i == 2 && filename[1] == ':' &&
(filename[2] == '/' || filename[2] == '\\'))
filename[2] = '/';
else if (filename[i] != '/' && filename[i] != '\\')
strlcat(filename, "/", sizeof(filename));
num_files = fl_filename_list(filename, &files, sort);
#else
num_files = fl_filename_list(directory_, &files, sort);
#endif /* WIN32 || __EMX__ */
if (num_files <= 0)
return (0);
for (i = 0, num_dirs = 0; i < num_files; i ++) {
if (strcmp(files[i]->d_name, "./")) {
snprintf(filename, sizeof(filename), "%s/%s", directory_,
files[i]->d_name);
icon = Fl_File_Icon::find(filename);
if ((icon && icon->type() == Fl_File_Icon::DIRECTORY) ||
_fl_filename_isdir_quick(filename)) {
num_dirs ++;
insert(num_dirs, files[i]->d_name, icon);
} else if (filetype_ == FILES &&
fl_filename_match(files[i]->d_name, pattern_)) {
add(files[i]->d_name, icon);
}
}
free(files[i]);
}
free(files);
}
return (num_files);
}
//
// 'Fl_File_Browser::filter()' - Set the filename filter.
//
void
Fl_File_Browser::filter(const char *pattern) // I - Pattern string
{
// If pattern is NULL set the pattern to "*"...
if (pattern)
pattern_ = pattern;
else
pattern_ = "*";
}
//
// End of "$Id$".
//