src/msw/filedlg.cpp

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        src/msw/filedlg.cpp
   3 // Purpose:     wxFileDialog
   4 // Author:      Julian Smart
   5 // Modified by:
   6 // Created:     01/02/97
   7 // RCS-ID:      $Id$
   8 // Copyright:   (c) Julian Smart
   9 // Licence:     wxWindows licence
  10 /////////////////////////////////////////////////////////////////////////////
  11
  12 // ============================================================================
  13 // declarations
  14 // ============================================================================
  15
  16 // ----------------------------------------------------------------------------
  17 // headers
  18 // ----------------------------------------------------------------------------
  19
  20 // For compilers that support precompilation, includes "wx.h".
  21 #include "wx/wxprec.h"
  22
  23 #ifdef __BORLANDC__
  24     #pragma hdrstop
  25 #endif
  26
  27 #if wxUSE_FILEDLG && !(defined(__SMARTPHONE__) && defined(__WXWINCE__))
  28
  29 #ifndef WX_PRECOMP
  30     #include "wx/utils.h"
  31     #include "wx/msgdlg.h"
  32     #include "wx/filedlg.h"
  33     #include "wx/filefn.h"
  34     #include "wx/intl.h"
  35     #include "wx/log.h"
  36     #include "wx/app.h"
  37 #endif
  38
  39 #include "wx/msw/wrapcdlg.h"
  40
  41 #include <stdlib.h>
  42 #include <string.h>
  43
  44 #include "wx/filename.h"
  45 #include "wx/tokenzr.h"
  46 #include "wx/math.h"
  47
  48 #include "wx/msw/missing.h"
  49
  50 // ----------------------------------------------------------------------------
  51 // constants
  52 // ----------------------------------------------------------------------------
  53
  54 #ifdef __WIN32__
  55 # define wxMAXPATH   65534
  56 #else
  57 # define wxMAXPATH   1024
  58 #endif
  59
  60 # define wxMAXFILE   1024
  61
  62 # define wxMAXEXT    5
  63
  64 // ----------------------------------------------------------------------------
  65 // globals
  66 // ----------------------------------------------------------------------------
  67
  68 // standard dialog size
  69 static wxRect gs_rectDialog(0, 0, 428, 266);
  70
  71 // ============================================================================
  72 // implementation
  73 // ============================================================================
  74
  75 IMPLEMENT_CLASS(wxFileDialog, wxFileDialogBase)
  76
  77 // ----------------------------------------------------------------------------
  78 // hook function for moving the dialog
  79 // ----------------------------------------------------------------------------
  80
  81 UINT_PTR APIENTRY
  82 wxFileDialogHookFunction(HWND      hDlg,
  83                          UINT      iMsg,
  84                          WPARAM    WXUNUSED(wParam),
  85                          LPARAM    lParam)
  86 {
  87     HWND   hwndDialog;
  88     hwndDialog = ::GetParent( hDlg );
  89     switch (iMsg)
  90     {
  91         case WM_DESTROY:
  92             {
  93                 RECT dlgRect;
  94                 GetWindowRect( hwndDialog, & dlgRect );
  95                 gs_rectDialog.x = dlgRect.left;
  96                 gs_rectDialog.y = dlgRect.top;
  97                 gs_rectDialog.width = dlgRect.right - dlgRect.left;
  98                 gs_rectDialog.height = dlgRect.bottom - dlgRect.top;
  99             }
 100             break;
 101
 102         case WM_NOTIFY:
 103             {
 104                 OFNOTIFY *   pNotifyCode;
 105                 pNotifyCode = (LPOFNOTIFY) lParam;
 106                 if (CDN_INITDONE == (pNotifyCode->hdr).code)
 107                 {
 108                     SetWindowPos( hwndDialog, HWND_TOP,
 109                                   gs_rectDialog.x,
 110                                   gs_rectDialog.y,
 111                                   gs_rectDialog.width,
 112                                   gs_rectDialog.height,
 113                                   SWP_NOZORDER|SWP_NOSIZE);
 114                  }
 115             }
 116             break;
 117     }
 118
 119     // do the default processing
 120     return 0;
 121 }
 122
 123 // ----------------------------------------------------------------------------
 124 // wxFileDialog
 125 // ----------------------------------------------------------------------------
 126
 127 wxFileDialog::wxFileDialog(wxWindow *parent,
 128                            const wxString& message,
 129                            const wxString& defaultDir,
 130                            const wxString& defaultFileName,
 131                            const wxString& wildCard,
 132                            long style,
 133                            const wxPoint& pos)
 134             : wxFileDialogBase(parent, message, defaultDir, defaultFileName,
 135                                wildCard, style, pos)
 136
 137 {
 138     if ( ( m_dialogStyle & wxMULTIPLE ) && ( m_dialogStyle & wxSAVE ) )
 139         m_dialogStyle &= ~wxMULTIPLE;
 140
 141     m_bMovedWindow = false;
 142
 143     // Must set to zero, otherwise the wx routines won't size the window
 144     // the second time you call the file dialog, because it thinks it is
 145     // already at the requested size.. (when centering)
 146     gs_rectDialog.x =
 147     gs_rectDialog.y = 0;
 148
 149 }
 150 void wxFileDialog::GetPaths(wxArrayString& paths) const
 151 {
 152     paths.Empty();
 153
 154     wxString dir(m_dir);
 155     if ( m_dir.Last() != _T('\\') )
 156         dir += _T('\\');
 157
 158     size_t count = m_fileNames.GetCount();
 159     for ( size_t n = 0; n < count; n++ )
 160     {
 161         if (wxFileName(m_fileNames[n]).IsAbsolute())
 162             paths.Add(m_fileNames[n]);
 163         else
 164             paths.Add(dir + m_fileNames[n]);
 165     }
 166 }
 167
 168 void wxFileDialog::GetFilenames(wxArrayString& files) const
 169 {
 170     files = m_fileNames;
 171 }
 172
 173 void wxFileDialog::SetPath(const wxString& path)
 174 {
 175     wxString ext;
 176     wxSplitPath(path, &m_dir, &m_fileName, &ext);
 177     if ( !ext.empty() )
 178         m_fileName << _T('.') << ext;
 179 }
 180
 181 void wxFileDialog::DoGetPosition( int *x, int *y ) const
 182 {
 183     *x = gs_rectDialog.x;
 184     *y = gs_rectDialog.y;
 185 }
 186
 187
 188 void wxFileDialog::DoGetSize(int *width, int *height) const
 189 {
 190     *width  = gs_rectDialog.width;
 191     *height = gs_rectDialog.height;
 192 }
 193
 194 void wxFileDialog::DoMoveWindow(int x, int y, int WXUNUSED(width), int WXUNUSED(height))
 195 {
 196     m_bMovedWindow = true;
 197
 198     gs_rectDialog.x = x;
 199     gs_rectDialog.y = y;
 200
 201     /*
 202         The width and height can not be set by the programmer
 203         its just not possible.  But the program can get the
 204         size of the Dlg after it has been shown, in case they need
 205         that data.
 206     */
 207 }
 208
 209 // helper used below in ShowModal(): style is used to determine whether to show
 210 // the "Save file" dialog (if it contains wxSAVE bit) or "Open file" one;
 211 // returns true on success or false on failure in which case err is filled with
 212 // the CDERR_XXX constant
 213 static bool DoShowCommFileDialog(OPENFILENAME *of, long style, DWORD *err)
 214 {
 215     if ( style & wxSAVE ? GetSaveFileName(of) : GetOpenFileName(of) )
 216         return true;
 217
 218     if ( err )
 219     {
 220 #ifdef __WXWINCE__
 221         // according to MSDN, CommDlgExtendedError() should work under CE as
 222         // well but apparently in practice it doesn't (anybody has more
 223         // details?)
 224         *err = GetLastError();
 225 #else
 226         *err = CommDlgExtendedError();
 227 #endif
 228     }
 229
 230     return false;
 231 }
 232
 233 int wxFileDialog::ShowModal()
 234 {
 235     HWND hWnd = 0;
 236     if (m_parent) hWnd = (HWND) m_parent->GetHWND();
 237     if (!hWnd && wxTheApp->GetTopWindow())
 238         hWnd = (HWND) wxTheApp->GetTopWindow()->GetHWND();
 239
 240     static wxChar fileNameBuffer [ wxMAXPATH ];           // the file-name
 241     wxChar        titleBuffer    [ wxMAXFILE+1+wxMAXEXT ];  // the file-name, without path
 242
 243     *fileNameBuffer = wxT('\0');
 244     *titleBuffer    = wxT('\0');
 245
 246 #if WXWIN_COMPATIBILITY_2_4
 247     long msw_flags = 0;
 248     if ( (m_dialogStyle & wxHIDE_READONLY) || (m_dialogStyle & wxSAVE) )
 249         msw_flags |= OFN_HIDEREADONLY;
 250 #else
 251     long msw_flags = OFN_HIDEREADONLY;
 252 #endif
 253
 254     if ( m_dialogStyle & wxFILE_MUST_EXIST )
 255         msw_flags |= OFN_PATHMUSTEXIST | OFN_FILEMUSTEXIST;
 256     /*
 257         If the window has been moved the programmer is probably
 258         trying to center or position it.  Thus we set the callback
 259         or hook function so that we can actually adjust the position.
 260         Without moving or centering the dlg, it will just stay
 261         in the upper left of the frame, it does not center
 262         automatically..  One additional note, when the hook is
 263         enabled, the PLACES BAR in the dlg (shown on later versions
 264         of windows (2000 and XP) will automatically be turned off
 265         according to the MSDN docs.  This is normal.  If the
 266         programmer needs the PLACES BAR (left side of dlg) they
 267         just shouldn't move or center the dlg.
 268     */
 269     if (m_bMovedWindow) // we need these flags.
 270     {
 271         msw_flags |= OFN_EXPLORER|OFN_ENABLEHOOK;
 272 #ifndef __WXWINCE__
 273         msw_flags |= OFN_ENABLESIZING;
 274 #endif
 275     }
 276
 277     if (m_dialogStyle & wxMULTIPLE )
 278     {
 279         // OFN_EXPLORER must always be specified with OFN_ALLOWMULTISELECT
 280         msw_flags |= OFN_EXPLORER | OFN_ALLOWMULTISELECT;
 281     }
 282
 283     // if wxCHANGE_DIR flag is not given we shouldn't change the CWD which the
 284     // standard dialog does by default (notice that under NT it does it anyhow,
 285     // OFN_NOCHANGEDIR or not, see below)
 286     if ( !(m_dialogStyle & wxCHANGE_DIR) )
 287     {
 288         msw_flags |= OFN_NOCHANGEDIR;
 289     }
 290
 291     if ( m_dialogStyle & wxOVERWRITE_PROMPT )
 292     {
 293         msw_flags |= OFN_OVERWRITEPROMPT;
 294     }
 295
 296     OPENFILENAME of;
 297     wxZeroMemory(of);
 298
 299     // the OPENFILENAME struct has been extended in newer version of
 300     // comcdlg32.dll, but as we don't use the extended fields anyhow, set
 301     // the struct size to the old value - otherwise, the programs compiled
 302     // with new headers will not work with the old libraries
 303 #if !defined(__WXWINCE__) && defined(_WIN32_WINNT) && (_WIN32_WINNT >= 0x0500)
 304     of.lStructSize       = sizeof(OPENFILENAME) -
 305                            (sizeof(void *) + 2*sizeof(DWORD));
 306 #else // old headers
 307     of.lStructSize       = sizeof(OPENFILENAME);
 308 #endif
 309
 310     of.hwndOwner         = hWnd;
 311     of.lpstrTitle        = WXSTRINGCAST m_message;
 312     of.lpstrFileTitle    = titleBuffer;
 313     of.nMaxFileTitle     = wxMAXFILE + 1 + wxMAXEXT;    // Windows 3.0 and 3.1
 314
 315     // Convert forward slashes to backslashes (file selector doesn't like
 316     // forward slashes) and also squeeze multiple consecutive slashes into one
 317     // as it doesn't like two backslashes in a row neither
 318
 319     wxString  dir;
 320     size_t    i, len = m_dir.length();
 321     dir.reserve(len);
 322     for ( i = 0; i < len; i++ )
 323     {
 324         wxChar ch = m_dir[i];
 325         switch ( ch )
 326         {
 327             case _T('/'):
 328                 // convert to backslash
 329                 ch = _T('\\');
 330
 331                 // fall through
 332
 333             case _T('\\'):
 334                 while ( i < len - 1 )
 335                 {
 336                     wxChar chNext = m_dir[i + 1];
 337                     if ( chNext != _T('\\') && chNext != _T('/') )
 338                         break;
 339
 340                     // ignore the next one, unless it is at the start of a UNC path
 341                     if (i > 0)
 342                         i++;
 343                     else
 344                         break;
 345                 }
 346                 // fall through
 347
 348             default:
 349                 // normal char
 350                 dir += ch;
 351         }
 352     }
 353
 354     of.lpstrInitialDir   = dir.c_str();
 355
 356     of.Flags             = msw_flags;
 357     of.lpfnHook          = wxFileDialogHookFunction;
 358
 359     wxArrayString wildDescriptions, wildFilters;
 360
 361     size_t items = wxParseCommonDialogsFilter(m_wildCard, wildDescriptions, wildFilters);
 362
 363     wxASSERT_MSG( items > 0 , _T("empty wildcard list") );
 364
 365     wxString filterBuffer;
 366
 367     for (i = 0; i < items ; i++)
 368     {
 369         filterBuffer += wildDescriptions[i];
 370         filterBuffer += wxT("|");
 371         filterBuffer += wildFilters[i];
 372         filterBuffer += wxT("|");
 373     }
 374
 375     // Replace | with \0
 376     for (i = 0; i < filterBuffer.Len(); i++ ) {
 377         if ( filterBuffer.GetChar(i) == wxT('|') ) {
 378             filterBuffer[i] = wxT('\0');
 379         }
 380     }
 381
 382     of.lpstrFilter  = (LPTSTR)filterBuffer.c_str();
 383     of.nFilterIndex = m_filterIndex + 1;
 384
 385     //=== Setting defaultFileName >>=========================================
 386
 387     wxStrncpy( fileNameBuffer, (const wxChar *)m_fileName, wxMAXPATH-1 );
 388     fileNameBuffer[ wxMAXPATH-1 ] = wxT('\0');
 389
 390     of.lpstrFile = fileNameBuffer;  // holds returned filename
 391     of.nMaxFile  = wxMAXPATH;
 392
 393     // we must set the default extension because otherwise Windows would check
 394     // for the existing of a wrong file with wxOVERWRITE_PROMPT (i.e. if the
 395     // user types "foo" and the default extension is ".bar" we should force it
 396     // to check for "foo.bar" existence and not "foo")
 397     wxString defextBuffer; // we need it to be alive until GetSaveFileName()!
 398     if (m_dialogStyle & wxSAVE)
 399     {
 400         const wxChar* extension = filterBuffer;
 401         int maxFilter = (int)(of.nFilterIndex*2L) - 1;
 402
 403         for( int i = 0; i < maxFilter; i++ )           // get extension
 404             extension = extension + wxStrlen( extension ) + 1;
 405
 406         // use dummy name a to avoid assert in AppendExtension
 407         defextBuffer = AppendExtension(wxT("a"), extension);
 408         if (defextBuffer.StartsWith(wxT("a.")))
 409         {
 410             defextBuffer.Mid(2);
 411             of.lpstrDefExt = defextBuffer.c_str();
 412         }
 413     }
 414
 415     // store off before the standard windows dialog can possibly change it
 416     const wxString cwdOrig = wxGetCwd();
 417
 418     //== Execute FileDialog >>=================================================
 419
 420     DWORD errCode;
 421     bool success = DoShowCommFileDialog(&of, m_dialogStyle, &errCode);
 422
 423     // sometimes we may have a mismatch between the headers used to compile the
 424     // library and the run-time version of comdlg32.dll, try to account for it
 425 #ifndef __WXWINCE__
 426     if ( !success && errCode == CDERR_STRUCTSIZE )
 427     {
 428         // The struct size has changed so try a smaller or bigger size
 429         const int oldStructSize = of.lStructSize;
 430         of.lStructSize = oldStructSize - (sizeof(void *) + 2*sizeof(DWORD));
 431         success = DoShowCommFileDialog(&of, m_dialogStyle, &errCode);
 432
 433         if ( !success && (errCode == CDERR_STRUCTSIZE) )
 434         {
 435             // try to adjust in the other direction
 436             of.lStructSize = oldStructSize + (sizeof(void *) + 2*sizeof(DWORD));
 437             success = DoShowCommFileDialog(&of, m_dialogStyle, &errCode);
 438         }
 439     }
 440 #endif // !__WXWINCE__
 441
 442     if ( success )
 443     {
 444         // GetOpenFileName will always change the current working directory on
 445         // (according to MSDN) "Windows NT 4.0/2000/XP" because the flag
 446         // OFN_NOCHANGEDIR has no effect.  If the user did not specify
 447         // wxCHANGE_DIR let's restore the current working directory to what it
 448         // was before the dialog was shown.
 449         if ( msw_flags & OFN_NOCHANGEDIR )
 450         {
 451             wxSetWorkingDirectory(cwdOrig);
 452         }
 453
 454         m_fileNames.Empty();
 455
 456         if ( ( m_dialogStyle & wxMULTIPLE ) &&
 457 #if defined(OFN_EXPLORER)
 458              ( fileNameBuffer[of.nFileOffset-1] == wxT('\0') )
 459 #else
 460              ( fileNameBuffer[of.nFileOffset-1] == wxT(' ') )
 461 #endif // OFN_EXPLORER
 462            )
 463         {
 464 #if defined(OFN_EXPLORER)
 465             m_dir = fileNameBuffer;
 466             i = of.nFileOffset;
 467             m_fileName = &fileNameBuffer[i];
 468             m_fileNames.Add(m_fileName);
 469             i += m_fileName.Len() + 1;
 470
 471             while (fileNameBuffer[i] != wxT('\0'))
 472             {
 473                 m_fileNames.Add(&fileNameBuffer[i]);
 474                 i += wxStrlen(&fileNameBuffer[i]) + 1;
 475             }
 476 #else
 477             wxStringTokenizer toke(fileNameBuffer, _T(" \t\r\n"));
 478             m_dir = toke.GetNextToken();
 479             m_fileName = toke.GetNextToken();
 480             m_fileNames.Add(m_fileName);
 481
 482             while (toke.HasMoreTokens())
 483                 m_fileNames.Add(toke.GetNextToken());
 484 #endif // OFN_EXPLORER
 485
 486             wxString dir(m_dir);
 487             if ( m_dir.Last() != _T('\\') )
 488                 dir += _T('\\');
 489
 490             m_path = dir + m_fileName;
 491             m_filterIndex = (int)of.nFilterIndex - 1;
 492         }
 493         else
 494         {
 495             //=== Adding the correct extension >>=================================
 496
 497             m_filterIndex = (int)of.nFilterIndex - 1;
 498
 499             if ( !of.nFileExtension ||
 500                  (of.nFileExtension && fileNameBuffer[of.nFileExtension] == wxT('\0')) )
 501             {
 502                 // User has typed a filename without an extension:
 503                 const wxChar* extension = filterBuffer;
 504                 int   maxFilter = (int)(of.nFilterIndex*2L) - 1;
 505
 506                 for( int i = 0; i < maxFilter; i++ )           // get extension
 507                     extension = extension + wxStrlen( extension ) + 1;
 508
 509                 m_fileName = AppendExtension(fileNameBuffer, extension);
 510                 wxStrncpy(fileNameBuffer, m_fileName.c_str(), wxMin(m_fileName.Len(), wxMAXPATH-1));
 511                 fileNameBuffer[wxMin(m_fileName.Len(), wxMAXPATH-1)] = wxT('\0');
 512             }
 513
 514             m_path = fileNameBuffer;
 515             m_fileName = wxFileNameFromPath(fileNameBuffer);
 516             m_fileNames.Add(m_fileName);
 517             m_dir = wxPathOnly(fileNameBuffer);
 518         }
 519     }
 520 #ifdef __WXDEBUG__
 521     else
 522     {
 523         // common dialog failed - why?
 524         if ( errCode != 0 )
 525         {
 526             // this msg is only for developers so don't translate it
 527             wxLogError(wxT("Common dialog failed with error code %0lx."),
 528                        errCode);
 529         }
 530         //else: it was just cancelled
 531     }
 532 #endif // __WXDEBUG__
 533
 534     return success ? wxID_OK : wxID_CANCEL;
 535
 536 }
 537
 538 #endif // wxUSE_FILEDLG && !(__SMARTPHONE__ && __WXWINCE__)
 539