src/common/utilscmn.cpp

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        utilscmn.cpp
   3 // Purpose:     Miscellaneous utility functions and classes
   4 // Author:      Julian Smart
   5 // Modified by:
   6 // Created:     29/01/98
   7 // RCS-ID:      $Id$
   8 // Copyright:   (c) 1998 Julian Smart
   9 // Licence:     wxWindows license
  10 /////////////////////////////////////////////////////////////////////////////
  11
  12 #ifdef __GNUG__
  13 #pragma implementation "utils.h"
  14 #endif
  15
  16 // For compilers that support precompilation, includes "wx.h".
  17 #include "wx/wxprec.h"
  18
  19 #ifdef __BORLANDC__
  20 #pragma hdrstop
  21 #endif
  22
  23 #ifndef WX_PRECOMP
  24 #include "wx/defs.h"
  25 #include "wx/utils.h"
  26 #include "wx/window.h"
  27 #include "wx/menu.h"
  28 #include "wx/frame.h"
  29 #include "wx/msgdlg.h"
  30 #include "wx/textdlg.h"
  31 #endif
  32
  33 #if wxUSE_IOSTREAMH
  34 #include <iostream.h>
  35 #include <fstream.h>
  36 #else
  37 #include <iostream>
  38 #include <fstream>
  39 #  ifdef _MSC_VER
  40       using namespace std;
  41 #  endif
  42 #endif
  43
  44 #include <ctype.h>
  45 #include <stdio.h>
  46 #include <stdlib.h>
  47 #include <string.h>
  48 #if !defined(__WATCOMC__)
  49 #if !(defined(_MSC_VER) && (_MSC_VER > 800))
  50 #include <errno.h>
  51 #endif
  52 #endif
  53 #include <time.h>
  54 #include <sys/types.h>
  55 #include <sys/stat.h>
  56
  57 // Pattern matching code.
  58 // Yes, this path is deliberate (for Borland compilation)
  59 #ifdef wx_mac /* MATTHEW: [5] Mac doesn't like paths with "/" */
  60 #include "glob.inc"
  61 #else
  62 #include "../common/glob.inc"
  63 #endif
  64
  65 #ifdef __WXMSW__
  66 #include "windows.h"
  67 #endif
  68
  69 #define _MAXPATHLEN 500
  70
  71 extern char *wxBuffer;
  72
  73 #ifdef __VMS__
  74 // we have no strI functions under VMS, therefore I have implemented
  75 // an inefficient but portable version: convert copies of strings to lowercase
  76 // and then use the normal comparison
  77 static void myLowerString(char *s)
  78 {
  79   while(*s){
  80     if(isalpha(*s)) *s = (char)tolower(*s);
  81     s++;
  82   }
  83 }
  84
  85 int strcasecmp(const char *str_1, const char *str_2)
  86 {
  87   char *temp1 = new char[strlen(str_1)+1];
  88   char *temp2 = new char[strlen(str_2)+1];
  89   strcpy(temp1,str_1);
  90   strcpy(temp2,str_2);
  91   myLowerString(temp1);
  92   myLowerString(temp2);
  93
  94   int result = strcmp(temp1,temp2);
  95   delete[] temp1;
  96   delete[] temp2;
  97
  98   return(result);
  99 }
 100
 101 int strncasecmp(const char *str_1, const char *str_2, size_t maxchar)
 102 {
 103   char *temp1 = new char[strlen(str_1)+1];
 104   char *temp2 = new char[strlen(str_2)+1];
 105   strcpy(temp1,str_1);
 106   strcpy(temp2,str_2);
 107   myLowerString(temp1);
 108   myLowerString(temp2);
 109
 110   int result = strncmp(temp1,temp2,maxchar);
 111   delete[] temp1;
 112   delete[] temp2;
 113
 114   return(result);
 115 }
 116 #endif
 117
 118 #ifdef __WINDOWS__
 119
 120 #ifndef __GNUWIN32__
 121 #define strcasecmp stricmp
 122 #define strncasecmp strnicmp
 123 #endif
 124
 125 #ifdef _MSC_VER
 126 #pragma warning (disable : 4245)
 127 #endif
 128
 129 #ifdef _MSC_VER
 130 #pragma warning (default : 4245)
 131 #endif
 132
 133 #else
 134 // This declaration is missing in SunOS!
 135 // (Yes, I know it is NOT ANSI-C but its in BSD libc)
 136 #if defined(__xlC) || defined(__AIX__) || defined(__GNUG__)
 137 extern "C"
 138 {
 139   int strcasecmp (const char *, const char *);
 140   int strncasecmp (const char *, const char *, size_t);
 141 }
 142 #endif
 143 #endif                          /* __WXMSW__ */
 144
 145
 146 char *
 147 copystring (const char *s)
 148 {
 149   if (s == NULL) s = "";
 150   size_t len = strlen (s) + 1;
 151
 152   char *news = new char[len];
 153   memcpy (news, s, len);        // Should be the fastest
 154
 155   return news;
 156 }
 157
 158 // Id generation
 159 static long wxCurrentId = 100;
 160
 161 long
 162 wxNewId (void)
 163 {
 164   return wxCurrentId++;
 165 }
 166
 167 long
 168 wxGetCurrentId(void) { return wxCurrentId; }
 169
 170 void
 171 wxRegisterId (long id)
 172 {
 173   if (id >= wxCurrentId)
 174     wxCurrentId = id + 1;
 175 }
 176
 177 void
 178 StringToFloat (char *s, float *number)
 179 {
 180   if (s && *s && number)
 181     *number = (float) strtod (s, (char **) NULL);
 182 }
 183
 184 void
 185 StringToDouble (char *s, double *number)
 186 {
 187   if (s && *s && number)
 188     *number = strtod (s, (char **) NULL);
 189 }
 190
 191 char *
 192 FloatToString (float number, const char *fmt)
 193 {
 194   static char buf[256];
 195
 196 //  sprintf (buf, "%.2f", number);
 197   sprintf (buf, fmt, number);
 198   return buf;
 199 }
 200
 201 char *
 202 DoubleToString (double number, const char *fmt)
 203 {
 204   static char buf[256];
 205
 206   sprintf (buf, fmt, number);
 207   return buf;
 208 }
 209
 210 void
 211 StringToInt (char *s, int *number)
 212 {
 213   if (s && *s && number)
 214     *number = (int) strtol (s, (char **) NULL, 10);
 215 }
 216
 217 void
 218 StringToLong (char *s, long *number)
 219 {
 220   if (s && *s && number)
 221     *number = strtol (s, (char **) NULL, 10);
 222 }
 223
 224 char *
 225 IntToString (int number)
 226 {
 227   static char buf[20];
 228
 229   sprintf (buf, "%d", number);
 230   return buf;
 231 }
 232
 233 char *
 234 LongToString (long number)
 235 {
 236   static char buf[20];
 237
 238   sprintf (buf, "%ld", number);
 239   return buf;
 240 }
 241
 242 // Array used in DecToHex conversion routine.
 243 static char hexArray[] = { '0', '1', '2', '3', '4', '5', '6', '7', '8', '9', 'A', 'B',
 244   'C', 'D', 'E', 'F' };
 245
 246 // Convert 2-digit hex number to decimal
 247 int wxHexToDec(const wxString& buf)
 248 {
 249   int firstDigit, secondDigit;
 250
 251   if (buf.GetChar(0) >= 'A')
 252     firstDigit = buf.GetChar(0) - 'A' + 10;
 253   else
 254     firstDigit = buf.GetChar(0) - '0';
 255
 256   if (buf.GetChar(1) >= 'A')
 257     secondDigit = buf.GetChar(1) - 'A' + 10;
 258   else
 259     secondDigit = buf.GetChar(1) - '0';
 260
 261   return firstDigit * 16 + secondDigit;
 262 }
 263
 264 // Convert decimal integer to 2-character hex string
 265 void wxDecToHex(int dec, char *buf)
 266 {
 267   int firstDigit = (int)(dec/16.0);
 268   int secondDigit = (int)(dec - (firstDigit*16.0));
 269   buf[0] = hexArray[firstDigit];
 270   buf[1] = hexArray[secondDigit];
 271   buf[2] = 0;
 272 }
 273
 274 // Convert decimal integer to 2-character hex string
 275 wxString wxDecToHex(int dec)
 276 {
 277     char buf[3];
 278     wxDecToHex(dec, buf);
 279     return wxString(buf);
 280 }
 281
 282 // Match a string INDEPENDENT OF CASE
 283 bool
 284 StringMatch (char *str1, char *str2, bool subString, bool exact)
 285 {
 286   if (str1 == NULL || str2 == NULL)
 287     return FALSE;
 288   if (str1 == str2)
 289     return TRUE;
 290
 291   if (subString)
 292     {
 293       int len1 = strlen (str1);
 294       int len2 = strlen (str2);
 295       int i;
 296
 297       // Search for str1 in str2
 298       // Slow .... but acceptable for short strings
 299       for (i = 0; i <= len2 - len1; i++)
 300         {
 301           if (strncasecmp (str1, str2 + i, len1) == 0)
 302             return TRUE;
 303         }
 304     }
 305   else if (exact)
 306     {
 307       if (strcasecmp (str1, str2) == 0)
 308         return TRUE;
 309     }
 310   else
 311     {
 312       int len1 = strlen (str1);
 313       int len2 = strlen (str2);
 314
 315       if (strncasecmp (str1, str2, wxMin (len1, len2)) == 0)
 316         return TRUE;
 317     }
 318
 319   return FALSE;
 320 }
 321
 322 // Return the current date/time
 323 // [volatile]
 324 wxString wxNow( void )
 325 {
 326   time_t now = time((time_t *) NULL);
 327   char *date = ctime(&now);
 328   date[24] = '\0';
 329   return wxString(date);
 330 }
 331
 332 /* Get Full RFC822 style email address */
 333 bool
 334 wxGetEmailAddress (char *address, int maxSize)
 335 {
 336   char host[65];
 337   char user[65];
 338
 339   if (wxGetHostName(host, 64) == FALSE)
 340     return FALSE;
 341   if (wxGetUserId(user, 64) == FALSE)
 342     return FALSE;
 343
 344   char tmp[130];
 345   strcpy(tmp, user);
 346   strcat(tmp, "@");
 347   strcat(tmp, host);
 348
 349   strncpy(address, tmp, maxSize - 1);
 350   address[maxSize-1] = '\0';
 351   return TRUE;
 352 }
 353
 354 /*
 355  * Strip out any menu codes
 356  */
 357
 358 char *wxStripMenuCodes (char *in, char *out)
 359 {
 360   if (!in)
 361     return (char *) NULL;
 362
 363   if (!out)
 364     out = copystring(in);
 365
 366   char *tmpOut = out;
 367
 368   while (*in)
 369     {
 370       if (*in == '&')
 371         {
 372           // Check && -> &, &x -> x
 373           if (*++in == '&')
 374             *out++ = *in++;
 375         }
 376       else if (*in == '\t')
 377         {
 378           // Remove all stuff after \t in X mode, and let the stuff as is
 379           // in Windows mode.
 380           // Accelerators are handled in wx_item.cc for Motif, and are not
 381           // YET supported in XView
 382           break;
 383         }
 384       else
 385         *out++ = *in++;
 386     }                           // while
 387
 388   *out = '\0';
 389
 390   return tmpOut;
 391 }
 392
 393
 394 /*
 395  * Window search functions
 396  *
 397  */
 398
 399 /*
 400  * If parent is non-NULL, look through children for a label or title
 401  * matching the specified string. If NULL, look through all top-level windows.
 402  *
 403  */
 404
 405 static wxWindow *wxFindWindowByLabel1 (const wxString& title, wxWindow * parent);
 406
 407 wxWindow *
 408 wxFindWindowByLabel (const wxString& title, wxWindow * parent)
 409 {
 410   if (parent)
 411     {
 412       return wxFindWindowByLabel1 (title, parent);
 413     }
 414   else
 415     {
 416       for (wxNode * node = wxTopLevelWindows.First (); node; node = node->Next ())
 417         {
 418           wxWindow *win = (wxWindow *) node->Data ();
 419           wxWindow *retwin = wxFindWindowByLabel1 (title, win);
 420           if (retwin)
 421             return retwin;
 422         }                       // for()
 423
 424     }
 425   return (wxWindow *) NULL;
 426 }
 427
 428 // Recursive
 429 static wxWindow *
 430 wxFindWindowByLabel1 (const wxString& title, wxWindow * parent)
 431 {
 432   if (parent)
 433     {
 434       if (parent->GetLabel() == title)
 435                 return parent;
 436     }
 437
 438   if (parent)
 439     {
 440       for (wxNode * node = parent->GetChildren()->First (); node; node = node->Next ())
 441         {
 442           wxWindow *win = (wxWindow *) node->Data ();
 443           wxWindow *retwin = wxFindWindowByLabel1 (title, win);
 444           if (retwin)
 445             return retwin;
 446         }                       // for()
 447
 448     }
 449
 450   return (wxWindow *) NULL;                     // Not found
 451
 452 }
 453
 454 /*
 455  * If parent is non-NULL, look through children for a name
 456  * matching the specified string. If NULL, look through all top-level windows.
 457  *
 458  */
 459
 460 static wxWindow *wxFindWindowByName1 (const wxString& title, wxWindow * parent);
 461
 462 wxWindow *
 463 wxFindWindowByName (const wxString& title, wxWindow * parent)
 464 {
 465   if (parent)
 466     {
 467       return wxFindWindowByName1 (title, parent);
 468     }
 469   else
 470     {
 471       for (wxNode * node = wxTopLevelWindows.First (); node; node = node->Next ())
 472         {
 473           wxWindow *win = (wxWindow *) node->Data ();
 474           wxWindow *retwin = wxFindWindowByName1 (title, win);
 475           if (retwin)
 476             return retwin;
 477         }                       // for()
 478
 479     }
 480   // Failed? Try by label instead.
 481   return wxFindWindowByLabel(title, parent);
 482 }
 483
 484 // Recursive
 485 static wxWindow *
 486 wxFindWindowByName1 (const wxString& title, wxWindow * parent)
 487 {
 488   if (parent)
 489     {
 490         if ( parent->GetName() == title )
 491                         return parent;
 492     }
 493
 494   if (parent)
 495     {
 496       for (wxNode * node = parent->GetChildren()->First (); node; node = node->Next ())
 497         {
 498           wxWindow *win = (wxWindow *) node->Data ();
 499           wxWindow *retwin = wxFindWindowByName1 (title, win);
 500           if (retwin)
 501             return retwin;
 502         }                       // for()
 503
 504     }
 505
 506   return (wxWindow *) NULL;                     // Not found
 507
 508 }
 509
 510 // Returns menu item id or -1 if none.
 511 int
 512 wxFindMenuItemId (wxFrame * frame, const wxString& menuString, const wxString& itemString)
 513 {
 514   wxMenuBar *menuBar = frame->GetMenuBar ();
 515   if (!menuBar)
 516     return -1;
 517   return menuBar->FindMenuItem (menuString, itemString);
 518 }
 519
 520 /*
 521  * wxDebugStreamBuf
 522  */
 523 #if !defined(_WINDLL)
 524
 525 wxDebugStreamBuf::wxDebugStreamBuf(void)
 526 {
 527         // <iostream> usage doesn't need this, and i have no idea how to simulate it.
 528 #if wxUSE_IOSTREAMH
 529         if (allocate())
 530           setp(base(),ebuf());
 531 #endif
 532 }
 533
 534 int wxDebugStreamBuf::overflow(int WXUNUSED(i))
 535 {
 536   int len = pptr() - pbase();
 537   char *txt = new char[len+1];
 538   strncpy(txt, pbase(), len);
 539   txt[len] = '\0';
 540 #ifdef __WXMSW__
 541   OutputDebugString((LPCSTR)txt);
 542 #else
 543   fprintf(stderr, txt);
 544 #endif
 545   setp(pbase(), epptr());
 546   delete[] txt;
 547   return EOF;
 548 }
 549
 550 int wxDebugStreamBuf::sync(void)
 551 {
 552   int len = pptr() - pbase();
 553   char *txt = new char[len+1];
 554   strncpy(txt, pbase(), len);
 555   txt[len] = '\0';
 556 #ifdef __WXMSW__
 557   OutputDebugString((LPCSTR)txt);
 558 #else
 559   fprintf(stderr, txt);
 560 #endif
 561   setp(pbase(), epptr());
 562   delete[] txt;
 563   return 0;
 564 }
 565
 566 #endif
 567
 568 /*
 569 On Fri, 21 Jul 1995, Paul Craven wrote:
 570
 571 > Is there a way to find the path of running program's executable? I can get
 572 > my home directory, and the current directory, but I don't know how to get the
 573 > executable directory.
 574 >
 575
 576 The code below (warty as it is), does what you want on most Unix,
 577 DOS, and Mac platforms (it's from the ALS Prolog main).
 578
 579 || Ken Bowen      Applied Logic Systems, Inc.         PO Box 180,
 580 ||====            Voice:  +1 (617)965-9191            Newton Centre,
 581 ||                FAX:    +1 (617)965-1636            MA  02159  USA
 582                   Email:  ken@als.com        WWW: http://www.als.com
 583 ------------------------------------------------------------------------
 584 */
 585
 586 // This code is commented out but it may be integrated with wxWin at
 587 // a later date, after testing. Thanks Ken!
 588 #if 0
 589
 590 /*--------------------------------------------------------------------*
 591  | whereami is given a filename f in the form:  whereami(argv[0])
 592  | It returns the directory in which the executable file (containing
 593  | this code [main.c] ) may be found.  A dot will be returned to indicate
 594  | the current directory.
 595  *--------------------------------------------------------------------*/
 596
 597 static void
 598 whereami(name)
 599     char *name;
 600 {
 601     register char *cutoff = NULL;       /* stifle -Wall */
 602     register char *s;
 603     register char *t;
 604     int   cc;
 605     char  ebuf[4096];
 606
 607     /*
 608      * See if the file is accessible either through the current directory
 609      * or through an absolute path.
 610      */
 611
 612     if (access(name, R_OK) == 0) {
 613
 614         /*-------------------------------------------------------------*
 615          * The file was accessible without any other work.  But the current
 616          * working directory might change on us, so if it was accessible
 617          * through the cwd, then we should get it for later accesses.
 618          *-------------------------------------------------------------*/
 619
 620         t = imagedir;
 621         if (!absolute_pathname(name)) {
 622 #if defined(DOS) || defined(__WIN32__)
 623             int   drive;
 624             char *newrbuf;
 625
 626             newrbuf = imagedir;
 627 #ifndef __DJGPP__
 628             if (*(name + 1) == ':') {
 629                 if (*name >= 'a' && *name <= 'z')
 630                     drive = (int) (*name - 'a' + 1);
 631                 else
 632                     drive = (int) (*name - 'A' + 1);
 633                 *newrbuf++ = *name;
 634                 *newrbuf++ = *(name + 1);
 635                 *newrbuf++ = DIR_SEPARATOR;
 636             }
 637             else {
 638                 drive = 0;
 639                 *newrbuf++ = DIR_SEPARATOR;
 640             }
 641             if (getcwd(newrbuf, drive) == 0) {  /* } */
 642 #else
 643             if (getcwd(newrbuf, 1024) == 0) {   /* } */
 644 #endif
 645 #else  /* DOS */
 646 #ifdef HAVE_GETWD
 647             if (getwd(imagedir) == 0) {         /* } */
 648 #else  /* !HAVE_GETWD */
 649             if (getcwd(imagedir, 1024) == 0) {
 650 #endif /* !HAVE_GETWD */
 651 #endif /* DOS */
 652                 fatal_error(FE_GETCWD, 0);
 653             }
 654             for (; *t; t++)     /* Set t to end of buffer */
 655                 ;
 656             if (*(t - 1) == DIR_SEPARATOR)      /* leave slash if already
 657                                                  * last char
 658                                                  */
 659                 cutoff = t - 1;
 660             else {
 661                 cutoff = t;     /* otherwise put one in */
 662                 *t++ = DIR_SEPARATOR;
 663             }
 664         }
 665 #if (!defined(__MAC__) && !defined(__DJGPP__) && !defined(__GO32__) && !defined(__WIN32__))
 666         else
 667                 (*t++ = DIR_SEPARATOR);
 668 #endif
 669
 670         /*-------------------------------------------------------------*
 671          * Copy the rest of the string and set the cutoff if it was not
 672          * already set.  If the first character of name is a slash, cutoff
 673          * is not presently set but will be on the first iteration of the
 674          * loop below.
 675          *-------------------------------------------------------------*/
 676
 677         for ((*name == DIR_SEPARATOR ? (s = name+1) : (s = name));;) {
 678             if (*s == DIR_SEPARATOR)
 679                         cutoff = t;
 680             if (!(*t++ = *s++))
 681                         break;
 682         }
 683
 684     }
 685     else {
 686
 687         /*-------------------------------------------------------------*
 688          * Get the path list from the environment.  If the path list is
 689          * inaccessible for any reason, leave with fatal error.
 690          *-------------------------------------------------------------*/
 691
 692 #ifdef __MAC__
 693         if ((s = getenv("Commands")) == (char *) 0)
 694 #else
 695         if ((s = getenv("PATH")) == (char *) 0)
 696 #endif
 697             fatal_error(FE_PATH, 0);
 698
 699         /*
 700          * Copy path list into ebuf and set the source pointer to the
 701          * beginning of this buffer.
 702          */
 703
 704         strcpy(ebuf, s);
 705         s = ebuf;
 706
 707         for (;;) {
 708             t = imagedir;
 709             while (*s && *s != PATH_SEPARATOR)
 710                 *t++ = *s++;
 711             if (t > imagedir && *(t - 1) == DIR_SEPARATOR)
 712                 ;               /* do nothing -- slash already is in place */
 713             else
 714                 *t++ = DIR_SEPARATOR;   /* put in the slash */
 715             cutoff = t - 1;     /* set cutoff */
 716             strcpy(t, name);
 717             if (access(imagedir, R_OK) == 0)
 718                 break;
 719
 720             if (*s)
 721                 s++;            /* advance source pointer */
 722             else
 723                 fatal_error(FE_INFND, 0);
 724         }
 725
 726     }
 727
 728     /*-------------------------------------------------------------*
 729      | At this point the full pathname should exist in imagedir and
 730      | cutoff should be set to the final slash.  We must now determine
 731      | whether the file name is a symbolic link or not and chase it down
 732      | if it is.  Note that we reuse ebuf for getting the link.
 733      *-------------------------------------------------------------*/
 734
 735 #ifdef HAVE_SYMLINK
 736     while ((cc = readlink(imagedir, ebuf, 512)) != -1) {
 737         ebuf[cc] = 0;
 738         s = ebuf;
 739         if (*s == DIR_SEPARATOR) {
 740             t = imagedir;
 741         }
 742         else {
 743             t = cutoff + 1;
 744         }
 745         for (;;) {
 746             if (*s == DIR_SEPARATOR)
 747                 cutoff = t;     /* mark the last slash seen */
 748             if (!(*t++ = *s++)) /* copy the character */
 749                 break;
 750         }
 751     }
 752
 753 #endif /* HAVE_SYMLINK */
 754
 755     strcpy(imagename, cutoff + 1);      /* keep the image name */
 756     *(cutoff + 1) = 0;          /* chop off the filename part */
 757 }
 758
 759 #endif
 760
 761 /*
 762  * N.B. these convenience functions must be separate from msgdlgg.cpp, textdlgg.cpp
 763  * since otherwise the generic code may be pulled in unnecessarily.
 764  */
 765
 766 int wxMessageBox(const wxString& message, const wxString& caption, long style,
 767                  wxWindow *parent, int WXUNUSED(x), int WXUNUSED(y) )
 768 {
 769     wxMessageDialog dialog(parent, message, caption, style);
 770
 771     int ans = dialog.ShowModal();
 772     switch ( ans )
 773     {
 774         case wxID_OK:
 775             return wxOK;
 776             break;
 777         case wxID_YES:
 778             return wxYES;
 779             break;
 780         case wxID_NO:
 781             return wxNO;
 782             break;
 783         default:
 784         case wxID_CANCEL:
 785             return wxCANCEL;
 786             break;
 787     }
 788     return ans;
 789 }
 790
 791 wxString wxGetTextFromUser(const wxString& message, const wxString& caption,
 792                         const wxString& defaultValue, wxWindow *parent,
 793                         int x, int y, bool WXUNUSED(centre) )
 794 {
 795     wxTextEntryDialog dialog(parent, message, caption, defaultValue, wxOK|wxCANCEL, wxPoint(x, y));
 796     if (dialog.ShowModal() == wxID_OK)
 797         return dialog.GetValue();
 798     else
 799         return wxString("");
 800 }
 801