Fl_Native_File_Chooser_FLTK.cxx

Go to the documentation of this file.

// "$Id: Fl_Native_File_Chooser_FLTK.cxx 7913 2010-11-29 18:18:27Z greg.ercolano $"
//
// FLTK native OS file chooser widget
//
// Copyright 1998-2010 by Bill Spitzak and others.
// Copyright 2004 Greg Ercolano.
// API changes + filter improvements by Nathan Vander Wilt 2005
//
// This library is free software; you can redistribute it and/or
// modify it under the terms of the GNU Library General Public
// License as published by the Free Software Foundation; either
// version 2 of the License, or (at your option) any later version.
//
// This library is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
// Library General Public License for more details.
//
// You should have received a copy of the GNU Library General Public
// License along with this library; if not, write to the Free Software
// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
// USA.
//
// Please report all bugs and problems to:
//
//     http://www.fltk.org/str.php
//

#include <FL/Fl_Native_File_Chooser.H>
#include <FL/Fl_File_Icon.H>
#define FLTK_CHOOSER_SINGLE    Fl_File_Chooser::SINGLE
#define FLTK_CHOOSER_DIRECTORY Fl_File_Chooser::DIRECTORY
#define FLTK_CHOOSER_MULTI     Fl_File_Chooser::MULTI
#define FLTK_CHOOSER_CREATE    Fl_File_Chooser::CREATE

#include "Fl_Native_File_Chooser_common.cxx"
#include <sys/stat.h>
#include <string.h>

Fl_Native_File_Chooser::Fl_Native_File_Chooser(int val) {
  _btype       = val;
  _options     = NO_OPTIONS;
  _filter      = NULL;
  _filtvalue   = 0;
  _parsedfilt  = NULL;
  _preset_file = NULL;
  _prevvalue   = NULL;
  _directory   = NULL;
  _errmsg      = NULL;
  _file_chooser = new Fl_File_Chooser(NULL, NULL, 0, NULL);
  type(val);                    // do this after _file_chooser created
  _nfilters    = 0;

  // Added by MG
  Fl_Button *b = _file_chooser->previewButton;
  Fl_Window *w = b->window();
  Fl_Group::current(w);         // adds a "Show hidden files" check button in _file_chooser's window
  show_hidden = new Fl_Check_Button(b->x() + b->w() + 10, b->y(), 145, b->h(), "Show hidden files");
  show_hidden->callback((Fl_Callback*)show_hidden_cb, this);
  my_fileList = _file_chooser->browser();
  _old_dir = 0;                                         // to detect directory changes
  prev_filtervalue = _file_chooser->filter_value();     // to detect filter changes
} 

Fl_Native_File_Chooser::~Fl_Native_File_Chooser() {
  delete _file_chooser;
  _filter      = strfree(_filter);
  _parsedfilt  = strfree(_parsedfilt);
  _preset_file = strfree(_preset_file);
  _prevvalue   = strfree(_prevvalue);
  _directory   = strfree(_directory);
  _errmsg      = strfree(_errmsg);
  _old_dir     = strfree(_old_dir);
}

// PRIVATE: SET ERROR MESSAGE
void Fl_Native_File_Chooser::errmsg(const char *msg) {
  _errmsg = strfree(_errmsg);
  _errmsg = strnew(msg);
}

// PRIVATE: translate Native types to Fl_File_Chooser types
int Fl_Native_File_Chooser::type_fl_file(int val) {
  switch (val) {
    case BROWSE_FILE:
      return(FLTK_CHOOSER_SINGLE);
    case BROWSE_DIRECTORY:
      return(FLTK_CHOOSER_SINGLE | FLTK_CHOOSER_DIRECTORY);
    case BROWSE_MULTI_FILE:
      return(FLTK_CHOOSER_MULTI);
    case BROWSE_MULTI_DIRECTORY:
      return(FLTK_CHOOSER_DIRECTORY | FLTK_CHOOSER_MULTI);
    case BROWSE_SAVE_FILE:
      return(FLTK_CHOOSER_SINGLE | FLTK_CHOOSER_CREATE);
    case BROWSE_SAVE_DIRECTORY:
      return(FLTK_CHOOSER_DIRECTORY | FLTK_CHOOSER_MULTI | FLTK_CHOOSER_CREATE);
    default:
      return(FLTK_CHOOSER_SINGLE);
  }
}

void Fl_Native_File_Chooser::type(int val) {
  _btype = val;
  _file_chooser->type(type_fl_file(val));
}

int Fl_Native_File_Chooser::type() const {
  return(_btype);
}

void Fl_Native_File_Chooser::options(int val) {
  _options = val;
}

int Fl_Native_File_Chooser::options() const {
  return(_options);
}

int Fl_Native_File_Chooser::show() {
  // FILTER
  if ( _parsedfilt ) {
    _file_chooser->filter(_parsedfilt);
  }

  // FILTER VALUE
  //     Set this /after/ setting the filter
  //
  _file_chooser->filter_value(_filtvalue);

  // DIRECTORY
  if ( _directory && _directory[0] ) {
    _file_chooser->directory(_directory);
  } else {
    _file_chooser->directory(_prevvalue);
  }

  // PRESET FILE
  if ( _preset_file ) {
    _file_chooser->value(_preset_file);
  }

  // OPTIONS: PREVIEW
  _file_chooser->preview( (options() & PREVIEW) ? 1 : 0);

  // OPTIONS: NEW FOLDER
  if ( options() & NEW_FOLDER )
    _file_chooser->type(_file_chooser->type() | FLTK_CHOOSER_CREATE);   // on

  // SHOW
  _file_chooser->show();

  // BLOCK WHILE BROWSER SHOWN
  while ( _file_chooser->shown() ) {
    if (_old_dir==0 || strcmp(_old_dir, _file_chooser->directory()) != 0) {
      _old_dir = strfree(_old_dir);
      _old_dir = strnew(_file_chooser->directory());
      if (!show_hidden->value()) remove_hidden_files(my_fileList);
    } else if (prev_filtervalue != _file_chooser->filter_value() ) {
      prev_filtervalue = _file_chooser->filter_value();
      if (!show_hidden->value() ) remove_hidden_files(my_fileList);
    }
    Fl::wait();
  }

  if ( _file_chooser->value() && _file_chooser->value()[0] ) {
    _prevvalue = strfree(_prevvalue);
    _prevvalue = strnew(_file_chooser->value());
    _filtvalue = _file_chooser->filter_value(); // update filter value

    // HANDLE SHOWING 'SaveAs' CONFIRM
    if ( options() & SAVEAS_CONFIRM && type() == BROWSE_SAVE_FILE ) {
      struct stat buf;
      if ( stat(_file_chooser->value(), &buf) != -1 ) {
        if ( buf.st_mode & S_IFREG ) {          // Regular file + exists?
          if ( exist_dialog() == 0 ) {
            return(1);
          }
        }
      }
    }
  }

  if ( _file_chooser->count() ) return(0);
  else return(1);
}

const char *Fl_Native_File_Chooser::errmsg() const {
  return(_errmsg ? _errmsg : "No error");
}

const char* Fl_Native_File_Chooser::filename() const {
  if ( _file_chooser->count() > 0 ) return(_file_chooser->value());
  return("");
}

const char* Fl_Native_File_Chooser::filename(int i) const {
  if ( i < _file_chooser->count() )
    return(_file_chooser->value(i+1));  // convert fltk 1 based to our 0 based
  return("");
}

void Fl_Native_File_Chooser::title(const char *val) {
  _file_chooser->label(val);
}

const char *Fl_Native_File_Chooser::title() const {
  return(_file_chooser->label());
}

void Fl_Native_File_Chooser::filter(const char *val) {
  _filter = strfree(_filter);
  _filter = strnew(val);
  parse_filter();
}

const char *Fl_Native_File_Chooser::filter() const {
  return(_filter);
}

int Fl_Native_File_Chooser::filters() const {
  return(_nfilters);
}

void Fl_Native_File_Chooser::filter_value(int val) {
  _filtvalue = val;
}

int Fl_Native_File_Chooser::filter_value() const {
  return(_filtvalue);
}

int Fl_Native_File_Chooser::count() const {
  return(_file_chooser->count());
}

void Fl_Native_File_Chooser::directory(const char *val) {
  _directory = strfree(_directory);
  _directory = strnew(val);
}

const char *Fl_Native_File_Chooser::directory() const {
  return(_directory);
}

// PRIVATE: Convert our filter format to fltk's chooser format
//     FROM                                     TO (FLTK)
//     -------------------------                --------------------------
//     "*.cxx"                                  "*.cxx Files(*.cxx)"
//     "C Files\t*.{cxx,h}"                     "C Files(*.{cxx,h})"
//     "C Files\t*.{cxx,h}\nText Files\t*.txt"  "C Files(*.{cxx,h})\tText Files(*.txt)"
//
//     Returns a modified version of the filter that the caller is responsible
//     for freeing with strfree().
//
void Fl_Native_File_Chooser::parse_filter() {
  _parsedfilt = strfree(_parsedfilt);   // clear previous parsed filter (if any)
  _nfilters = 0;
  char *in = _filter;
  if ( !in ) return;

  int has_name = strchr(in, '\t') ? 1 : 0;

  char mode = has_name ? 'n' : 'w';     // parse mode: n=title, w=wildcard
  char wildcard[1024] = "";             // parsed wildcard
  char name[1024] = "";

  // Parse filter user specified
  for ( ; 1; in++ ) {
    /*** DEBUG
    printf("WORKING ON '%c': mode=<%c> name=<%s> wildcard=<%s>\n",
                        *in, mode,     name,     wildcard);
    ***/

    switch (*in) {
      // FINISHED PARSING NAME?
      case '\t':
        if ( mode != 'n' ) goto regchar;
        mode = 'w';
        break; 
      // ESCAPE NEXT CHAR
      case '\\':
        ++in;
        goto regchar; 
      // FINISHED PARSING ONE OF POSSIBLY SEVERAL FILTERS?
      case '\r':
      case '\n':
      case '\0':
        // APPEND NEW FILTER TO LIST
        if ( wildcard[0] ) {
          // OUT: "name(wild)\tname(wild)"
          char comp[2048];
          sprintf(comp, "%s%.511s(%.511s)", ((_parsedfilt)?"\t":""),
                                            name, wildcard);
          _parsedfilt = strapp(_parsedfilt, comp);
          _nfilters++;
          //DEBUG printf("DEBUG: PARSED FILT NOW <%s>\n", _parsedfilt);
        }
        // RESET
        wildcard[0] = name[0] = '\0';
        mode = strchr(in, '\t') ? 'n' : 'w';
        // DONE?
        if ( *in == '\0' ) return;      // done
        else continue;                  // not done yet, more filters

      // Parse all other chars
      default:                          // handle all non-special chars
      regchar:                          // handle regular char
        switch ( mode ) {
          case 'n': chrcat(name, *in);     continue;
          case 'w': chrcat(wildcard, *in); continue;
        }
        break;
    }
  }
  //NOTREACHED
}

void Fl_Native_File_Chooser::preset_file(const char* val) {
  _preset_file = strfree(_preset_file);
  _preset_file = strnew(val);
}

const char* Fl_Native_File_Chooser::preset_file() const {
  return(_preset_file);
}

void Fl_Native_File_Chooser::show_hidden_cb(Fl_Check_Button *o, void *data)
{
  Fl_Native_File_Chooser *mychooser = (Fl_Native_File_Chooser *)data;
  if (o->value()) {
    mychooser->my_fileList->load(mychooser->_file_chooser->directory());
  } else {
    remove_hidden_files(mychooser->my_fileList);
    mychooser->my_fileList->redraw();
  }
}

// PRIVATE: Don't show hidden files
void Fl_Native_File_Chooser::remove_hidden_files(Fl_File_Browser *my_fileList)
{
  int count = my_fileList->size();
  for(int num = count; num >= 1; num--) {
    const char *p = my_fileList->text(num);
    if (*p == '.' && strcmp(p, "../") != 0) my_fileList->remove(num);
  }
  my_fileList->topline(1);
}

// PRIVATE: Don't show hidden files
int Fl_Native_File_Chooser::exist_dialog() {
  return(fl_choice("File exists. Are you sure you want to overwrite?", 
                   "Cancel", "   OK   ", NULL));
}

//
// End of "$Id: Fl_Native_File_Chooser_FLTK.cxx 7913 2010-11-29 18:18:27Z greg.ercolano $".
//