s_file.c 30.8 KB
Newer Older
Miller Puckette's avatar
Miller Puckette committed
1 2 3 4 5 6 7 8
/* Copyright (c) 1997-2004 Miller Puckette.
* For information on usage and redistribution, and for a DISCLAIMER OF ALL
* WARRANTIES, see the file, "LICENSE.txt," in this distribution.  */

/*
 * this file implements a mechanism for storing and retrieving preferences.
 * Should later be renamed "preferences.c" or something.
 *
9
 * In unix this is handled by the "~/.pd-l2ork/user.settings" file, in windows by
Miller Puckette's avatar
Miller Puckette committed
10 11 12
 * the registry, and in MacOS by the Preferences system.
 */

Hans-Christoph Steiner's avatar
Hans-Christoph Steiner committed
13 14
#include "config.h"

Miller Puckette's avatar
Miller Puckette committed
15 16 17 18 19 20
#include "m_pd.h"
#include "s_stuff.h"
#include <string.h>
#include <stdlib.h>
#include <stdio.h>
#include <errno.h>
Hans-Christoph Steiner's avatar
Hans-Christoph Steiner committed
21 22 23 24 25 26 27

#ifdef HAVE_UNISTD_H
#include <unistd.h>
#endif

#ifdef HAVE_UNISTD_H
/* XXX Hack!  This should be done with a cleaner check. */
Miller Puckette's avatar
Miller Puckette committed
28 29 30 31 32 33
#include <sys/types.h>
#include <sys/stat.h>
#include <sys/types.h>
#include <sys/stat.h>
#include <fcntl.h>
#endif
Hans-Christoph Steiner's avatar
Hans-Christoph Steiner committed
34

Miller Puckette's avatar
Miller Puckette committed
35 36 37 38
#ifdef MSW
#include <windows.h>
#include <tchar.h>
#endif
Miller Puckette's avatar
Miller Puckette committed
39 40 41
#ifdef _MSC_VER  /* This is only for Microsoft's compiler, not cygwin, e.g. */
#define snprintf sprintf_s
#endif
Miller Puckette's avatar
Miller Puckette committed
42

43
int sys_defeatrt, sys_zoom;
Miller Puckette's avatar
Miller Puckette committed
44 45 46 47 48
t_symbol *sys_flags = &s_;
void sys_doflags( void);

#ifdef UNIX

49
#define USER_CONFIG_DIR ".purr-data"
50

Miller Puckette's avatar
Miller Puckette committed
51 52 53 54
static char *sys_prefbuf;

static void sys_initloadpreferences( void)
{
Hans-Christoph Steiner's avatar
Hans-Christoph Steiner committed
55
    char filenamebuf[FILENAME_MAX], *homedir = getenv("HOME");
Miller Puckette's avatar
Miller Puckette committed
56
    int fd, length;
57
    char user_prefs_file[FILENAME_MAX]; /* user prefs file */
Miller Puckette's avatar
Miller Puckette committed
58
        /* default prefs embedded in the package */
59
    char default_prefs_file[FILENAME_MAX];
Miller Puckette's avatar
Miller Puckette committed
60 61
    struct stat statbuf;

62
    snprintf(default_prefs_file, FILENAME_MAX, "%s/default.settings", 
63
             sys_libdir->s_name);
64

Miller Puckette's avatar
Miller Puckette committed
65
    if (homedir)
66
        snprintf(user_prefs_file, FILENAME_MAX, "%s/" USER_CONFIG_DIR "/user.settings", homedir);
67 68 69 70 71
    if (stat(user_prefs_file, &statbuf) == 0) 
        strncpy(filenamebuf, user_prefs_file, FILENAME_MAX);
    else if (stat(default_prefs_file, &statbuf) == 0)
        strncpy(filenamebuf, default_prefs_file, FILENAME_MAX);
    else
Hans-Christoph Steiner's avatar
Hans-Christoph Steiner committed
72 73
        return;
    filenamebuf[FILENAME_MAX-1] = 0;
Miller Puckette's avatar
Miller Puckette committed
74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141
    if ((fd = open(filenamebuf, 0)) < 0)
    {
        if (sys_verbose)
            perror(filenamebuf);
        return;
    }
    length = lseek(fd, 0, 2);
    if (length < 0)
    {
        if (sys_verbose)
            perror(filenamebuf);
        close(fd);
        return;
    }
    lseek(fd, 0, 0);
    if (!(sys_prefbuf = malloc(length + 2)))
    {
        error("couldn't allocate memory for preferences buffer");
        close(fd);
        return;
    }
    sys_prefbuf[0] = '\n';
    if (read(fd, sys_prefbuf+1, length) < length)
    {
        perror(filenamebuf);
        sys_prefbuf[0] = 0;
        close(fd);
        return;
    }
    sys_prefbuf[length+1] = 0;
    close(fd);
    if (sys_verbose)
        post("success reading preferences from: %s", filenamebuf);
}

static int sys_getpreference(const char *key, char *value, int size)
{
    char searchfor[80], *where, *whereend;
    if (!sys_prefbuf)
        return (0);
    sprintf(searchfor, "\n%s:", key);
    where = strstr(sys_prefbuf, searchfor);
    if (!where)
        return (0);
    where += strlen(searchfor);
    while (*where == ' ' || *where == '\t')
        where++;
    for (whereend = where; *whereend && *whereend != '\n'; whereend++)
        ;
    if (*whereend == '\n')
        whereend--;
    if (whereend > where + size - 1)
        whereend = where + size - 1;
    strncpy(value, where, whereend+1-where);
    value[whereend+1-where] = 0;
    return (1);
}

static void sys_doneloadpreferences( void)
{
    if (sys_prefbuf)
        free(sys_prefbuf);
}

static FILE *sys_prefsavefp;

static void sys_initsavepreferences( void)
{
Ivica Bukvic's avatar
Ivica Bukvic committed
142
    char filenamebuf[FILENAME_MAX], *homedir = getenv("HOME");
143
    struct stat statbuf;
Miller Puckette's avatar
Miller Puckette committed
144 145 146

    if (!homedir)
        return;
147
    snprintf(filenamebuf, FILENAME_MAX, "%s/" USER_CONFIG_DIR, homedir);
148 149 150 151 152
    filenamebuf[FILENAME_MAX-1] = 0;
    if (stat(filenamebuf, &statbuf) || !S_ISDIR(statbuf.st_mode)) {
      // user config dir doesn't exist yet, try to create it
      if (mkdir(filenamebuf, 0755)) {
        pd_error(0, "%s: %s",filenamebuf, strerror(errno));
153
        return;
154 155
      }
    }
156
    snprintf(filenamebuf, FILENAME_MAX, "%s/" USER_CONFIG_DIR "/user.settings", homedir);
Hans-Christoph Steiner's avatar
Hans-Christoph Steiner committed
157
    filenamebuf[FILENAME_MAX-1] = 0;
Miller Puckette's avatar
Miller Puckette committed
158 159
    if ((sys_prefsavefp = fopen(filenamebuf, "w")) == NULL)
    {
Ivica Bukvic's avatar
Ivica Bukvic committed
160 161
        //snprintf(errbuf, FILENAME_MAX, "%s: %s",filenamebuf, strerror(errno));
        pd_error(0, "%s: %s",filenamebuf, strerror(errno));
Miller Puckette's avatar
Miller Puckette committed
162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192
    }
}

static void sys_putpreference(const char *key, const char *value)
{
    if (sys_prefsavefp)
        fprintf(sys_prefsavefp, "%s: %s\n",
            key, value);
}

static void sys_donesavepreferences( void)
{
    if (sys_prefsavefp)
    {
        fclose(sys_prefsavefp);
        sys_prefsavefp = 0;
    }
}

#endif /* UNIX */

#ifdef MSW

static void sys_initloadpreferences( void)
{
}

static int sys_getpreference(const char *key, char *value, int size)
{
    HKEY hkey;
    DWORD bigsize = size;
193
    LONG err = RegOpenKeyEx(HKEY_CURRENT_USER,
194
        "Software\\Purr-Data", 0,  KEY_QUERY_VALUE, &hkey);
Miller Puckette's avatar
Miller Puckette committed
195 196
    if (err != ERROR_SUCCESS)
    {
197 198 199 200 201 202
        err = RegOpenKeyEx(HKEY_LOCAL_MACHINE,
            "Software\\Purr-Data", 0,  KEY_QUERY_VALUE, &hkey);
        if (err != ERROR_SUCCESS)
        {
            return (0);
	}
Miller Puckette's avatar
Miller Puckette committed
203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224
    }
    err = RegQueryValueEx(hkey, key, 0, 0, value, &bigsize);
    if (err != ERROR_SUCCESS)
    {
        RegCloseKey(hkey);
        return (0);
    }
    RegCloseKey(hkey);
    return (1);
}

static void sys_doneloadpreferences( void)
{
}

static void sys_initsavepreferences( void)
{
}

static void sys_putpreference(const char *key, const char *value)
{
    HKEY hkey;
225
    LONG err = RegCreateKeyEx(HKEY_CURRENT_USER,
226
        "Software\\Purr-Data", 0, NULL, REG_OPTION_NON_VOLATILE, KEY_SET_VALUE,
Miller Puckette's avatar
Miller Puckette committed
227 228 229
        NULL, &hkey, NULL);
    if (err != ERROR_SUCCESS)
    {
230 231
        post("unable to create registry entry: %s: error %lx\n", key,
            (long unsigned int)err);
Miller Puckette's avatar
Miller Puckette committed
232 233
        return;
    }
Hans-Christoph Steiner's avatar
Hans-Christoph Steiner committed
234
    err = RegSetValueEx(hkey, key, 0, REG_EXPAND_SZ, value, strlen(value)+1);
Miller Puckette's avatar
Miller Puckette committed
235 236 237 238 239 240 241 242 243 244 245 246 247
    if (err != ERROR_SUCCESS)
        post("unable to set registry entry: %s\n", key);
    RegCloseKey(hkey);
}

static void sys_donesavepreferences( void)
{
}

#endif /* MSW */

#ifdef __APPLE__

Hans-Christoph Steiner's avatar
Hans-Christoph Steiner committed
248
// prefs file that is currently the one to save to
249
static char current_prefs[FILENAME_MAX] = "org.puredata.pd-l2ork"; 
Hans-Christoph Steiner's avatar
Hans-Christoph Steiner committed
250

251
static char *sys_prefbuf;
Miller Puckette's avatar
Miller Puckette committed
252

253 254 255 256 257 258 259 260 261
// Maximum number of bytes to be read on each iteration. Note that the buffer
// is resized in increments of BUFSZ until the entire prefs data has been
// read. For best performance, BUFSZ should be a sizeable fraction of the
// expected preference data size. The size 4096 matches PD's internal GUI
// socket size and thus should normally be enough to read the entire prefs
// data in one go.
#define BUFSZ 4096

// AG: We have to go to some lengths here since 'defaults read' doesn't
262 263 264 265 266 267 268 269
// properly deal with UTF-8 characters in the prefs data. 'plutil' does the
// trick, however, so we use that to read the entire prefs data at once from a
// pipe, converting it to JSON format which can then be translated to Pd's
// Unix preferences file format using sed. The result is stored in a character
// buffer for efficient access. From there we can retrieve the individual keys
// in the same fashion as on Unix. A welcome side effect is that loading the
// prefs is *much* faster now than with the previous method which invoked
// 'defaults read' on each individual key.
270

271 272
static int save_prefs_later = 0;

273
static void sys_initloadpreferences(void)
Miller Puckette's avatar
Miller Puckette committed
274
{
275 276 277 278
    char cmdbuf[MAXPDSTRING], *buf;
    FILE *fp;
    size_t sz, n = 0;
    int res;
279
    char default_prefs[FILENAME_MAX];  // default prefs embedded in the package
280
    char embedded_prefs[FILENAME_MAX]; // overrides others for standalone app
281
    char user_prefs[FILENAME_MAX];     // user preferences
282 283 284 285 286 287 288 289 290 291 292 293 294 295 296
    char embedded_prefs_file[FILENAME_MAX];
    char user_prefs_file[FILENAME_MAX];
    const char *prefs, *homedir = getenv("HOME");
    struct stat statbuf;
    // On the Mac, we first look for an embedded prefs file, then for a user
    // prefs file, and fall back to the defaults in the package if none of
    // these exist. Note that Pd-l2ork can't create standalone apps à la
    // Pd-extended right now, but we might want to support them in the future,
    // so we handle the embedded prefs case anyway.
    snprintf(default_prefs, FILENAME_MAX,
	     "%s/../org.puredata.pd-l2ork.default",
             sys_libdir->s_name);
    snprintf(embedded_prefs, FILENAME_MAX,
	     "%s/../org.puredata.pd-l2ork",
             sys_libdir->s_name);
297 298
    snprintf(user_prefs, FILENAME_MAX,
             "%s/Library/Preferences/org.puredata.pd-l2ork", homedir);
299
    snprintf(embedded_prefs_file, FILENAME_MAX, "%s.plist", embedded_prefs);
300
    snprintf(user_prefs_file, FILENAME_MAX, "%s.plist", user_prefs);
301 302 303 304 305 306 307
    if (stat(embedded_prefs_file, &statbuf) == 0) {
      // Read from and write to the embedded prefs (standalone app).
      prefs = embedded_prefs;
      strncpy(current_prefs, embedded_prefs, FILENAME_MAX);
    } else if (stat(user_prefs_file, &statbuf) == 0) {
      // Read from and write to the user prefs.
      prefs = current_prefs;
308
      strncpy(current_prefs, user_prefs, FILENAME_MAX);
309 310 311
    } else {
      // Read from the package defaults and write to the user prefs.
      prefs = default_prefs;
312
      strncpy(current_prefs, user_prefs, FILENAME_MAX);
313 314
      // AG: Remember to save the prefs later after we loaded them (see below).
      save_prefs_later = 1;
315
    }
316 317
    // This looks complicated, but is rather straightforward. The individual
    // stages of the pipe are:
318 319
    // 1. plutil -convert json -r -o -: grab our defaults and convert to JSON
    // 2. sed: a few edits remove the extra JSON bits (curly braces, string
Albert Gräf's avatar
Albert Gräf committed
320 321 322 323 324 325 326 327
    //    quotes, unwanted whitespace and character escapes) and produce
    //    Pd-L2Ork's Unix prefs format, i.e.:
    // JSON                        -->            Unix prefs
    // {
    //   "nloadlib" : "33",                       nloadlib: 33
    //   "loadlib1" : "libdir",                   loadlib1: libdir
    //   "path1" : "\/System\/Library\/Fonts"     path1: /System/Library/Fonts
    // }
328
    snprintf(cmdbuf, MAXPDSTRING,
329
        "plutil -convert json -r -o - \"%s.plist\" "
330 331 332 333 334
        "| sed -E "
          "-e 's/[{}]//g' "
          "-e 's/^ *\"(([^\"]|\\\\.)*)\" *: *\"(([^\"]|\\\\.)*)\".*/\\1: \\3/' "
          "-e 's/\\\\(.)/\\1/g'",
        prefs);
335 336 337 338 339 340 341 342
    // open the pipe
    fp = popen(cmdbuf, "r");
    if (!fp) {
      // if opening the pipe failed for some reason, bail out now
      if (sys_verbose)
        perror(current_prefs);
      error("%s: %s", current_prefs, strerror(errno));
      return;
343
    }
344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365
    // Initialize the buffer. Note that we have to reserve one extra byte for
    // the terminating NUL character. The buf variable always points to the
    // current chunk of memory to be written into.
    sys_prefbuf = buf = malloc((sz = BUFSZ)+1);
    while (buf && (n = fread(buf, 1, BUFSZ, fp)) > 0) {
      char *newbuf;
      size_t oldsz = sz;
      // terminating NUL byte, to be safe
      buf[n] = 0;
      // if the byte count is short, then all data has been read; bail out
      if (n < BUFSZ) break;
      // more data may follow, enlarge the buffer in BUFSZ increments
      sz += BUFSZ;
      if ((newbuf = realloc(sys_prefbuf, sz+1))) {
        // memory allocation succeeded, prepare the new buffer for the next read
        sys_prefbuf = newbuf;
        // adjust the current buffer pointer
        buf = newbuf + oldsz;
      } else {
        // memory allocation failed, bail out
        buf = NULL;
      }
366
    }
367 368 369 370 371 372 373 374
    // close the pipe
    res = pclose(fp);
    if (res)
      post("%s: pclose returned exit status %d", current_prefs, WEXITSTATUS(res));
    // check for memory allocation errors
    if (!buf) {
      error("couldn't allocate memory for preferences buffer");
      return;
Miller Puckette's avatar
Miller Puckette committed
375
    }
376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391
    // When we come here, n is the length of the last chunk we read into buf.
    // Add the terminating NUL byte there.
    buf[n] = 0;
    if (sys_verbose)
      post("success reading preferences from: %s", current_prefs);
    //post("%s: read %d bytes of preferences data", current_prefs, strlen(sys_prefbuf));
}

static int sys_getpreference(const char *key, char *value, int size)
{
    char searchfor[80], *where, *whereend;
    if (!sys_prefbuf)
        return (0);
    sprintf(searchfor, "\n%s:", key);
    where = strstr(sys_prefbuf, searchfor);
    if (!where)
Miller Puckette's avatar
Miller Puckette committed
392
        return (0);
393 394 395 396 397 398 399 400 401 402 403 404
    where += strlen(searchfor);
    while (*where == ' ' || *where == '\t')
        where++;
    for (whereend = where; *whereend && *whereend != '\n'; whereend++)
        ;
    if (*whereend == '\n')
        whereend--;
    if (whereend > where + size - 1)
        whereend = where + size - 1;
    strncpy(value, where, whereend+1-where);
    value[whereend+1-where] = 0;
    return (1);
Miller Puckette's avatar
Miller Puckette committed
405 406 407 408
}

static void sys_doneloadpreferences( void)
{
409 410 411
    if (sys_prefbuf)
        free(sys_prefbuf);
    sys_prefbuf = NULL;
412 413 414 415 416 417 418 419
    if (save_prefs_later) {
      // AG: We need to save the default prefs to the user prefs at this point
      // in order to avoid losing them, in case the recent file list is written
      // without first saving the defaults (fixes #339).
      extern void glob_savepreferences(t_pd *dummy);
      glob_savepreferences(NULL);
      save_prefs_later = 0;
    }
Miller Puckette's avatar
Miller Puckette committed
420 421
}

422 423 424 425 426 427 428 429 430 431 432
// AG: We use a similar approach here to import the data into the defaults
// storage in one go. To these ends, a temporary plist file in xml format is
// created which is then submitted to 'defaults import'. This is *much* faster
// than the previous implementation which invoked the shell to run 'defaults
// write' for each individual key.

#define save_prefs_template "/tmp/pd-l2ork.defaults.plist.XXXXXX"

static FILE *save_fp;
static char save_prefs[] = save_prefs_template;

Miller Puckette's avatar
Miller Puckette committed
433 434
static void sys_initsavepreferences( void)
{
435 436 437 438 439 440 441 442 443 444 445 446 447 448 449
  strcpy(save_prefs, save_prefs_template);
  int fd = mkstemp(save_prefs);
  if (fd < 0) {
    error("save preferences: %s", strerror(errno));
    return;
  }
  save_fp = fdopen(fd, "w");
  if (!save_fp) {
    error("save preferences: %s", strerror(errno));
    return;
  }
  fprintf(save_fp, "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n"
"<!DOCTYPE plist PUBLIC \"-//Apple Computer//DTD PLIST 1.0//EN\" \"http://www.apple.com/DTDs/PropertyList-1.0.dtd\">\n"
"<plist version=\"1.0\">\n"
"<dict>\n");
Miller Puckette's avatar
Miller Puckette committed
450 451 452 453
}

static void sys_putpreference(const char *key, const char *value)
{
454 455 456 457
  if (!save_fp) return;
  fprintf(save_fp,
          "<key>%s</key>\n<string>%s</string>\n",
          key, value);
Miller Puckette's avatar
Miller Puckette committed
458 459 460 461
}

static void sys_donesavepreferences( void)
{
462 463 464 465 466 467 468 469 470 471
  if (!save_fp) return;
  fprintf(save_fp, "</dict>\n</plist>\n");
  fclose(save_fp);
  save_fp = 0;
  char cmdbuf[MAXPDSTRING];
  snprintf(cmdbuf, MAXPDSTRING,
           "defaults import '%s' '%s' 2> /dev/null",
           current_prefs, save_prefs);
  system(cmdbuf);
  unlink(save_prefs);
Miller Puckette's avatar
Miller Puckette committed
472 473 474 475 476
}

#endif /* __APPLE__ */


477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495
#ifdef _WIN32
static int check_exists(const char*path)
{
    char pathbuf[MAXPDSTRING];
    wchar_t ucs2path[MAXPDSTRING];
    sys_bashfilename(path, pathbuf);
    u8_utf8toucs2(ucs2path, MAXPDSTRING, pathbuf, MAXPDSTRING-1);
    return (0 ==  _waccess(ucs2path, 0));
}
#else
#include <unistd.h>
static int check_exists(const char*path)
{
    char pathbuf[MAXPDSTRING];
    sys_bashfilename(path, pathbuf);
    return (0 == access(pathbuf, 0));
}
#endif

Miller Puckette's avatar
Miller Puckette committed
496 497 498 499 500 501
void sys_loadpreferences( void)
{
    int naudioindev, audioindev[MAXAUDIOINDEV], chindev[MAXAUDIOINDEV];
    int naudiooutdev, audiooutdev[MAXAUDIOOUTDEV], choutdev[MAXAUDIOOUTDEV];
    int nmidiindev, midiindev[MAXMIDIINDEV];
    int nmidioutdev, midioutdev[MAXMIDIOUTDEV];
502
    int i, rate = 0, advance = -1, callback = 0, blocksize = 0,
503
        api, maxi;
Miller Puckette's avatar
Miller Puckette committed
504 505 506 507 508 509 510 511 512 513 514 515 516
    char prefbuf[MAXPDSTRING], keybuf[80];

    sys_initloadpreferences();
        /* load audio preferences */
    if (sys_getpreference("audioapi", prefbuf, MAXPDSTRING)
        && sscanf(prefbuf, "%d", &api) > 0)
            sys_set_audio_api(api);
            /* JMZ/MB: brackets for initializing */
    if (sys_getpreference("noaudioin", prefbuf, MAXPDSTRING) &&
        (!strcmp(prefbuf, ".") || !strcmp(prefbuf, "True")))
            naudioindev = 0;
    else
    {
517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535
        /* AG: naudioin key */
        /* The idea here is to keep track of the actual number of devices, so
           that we don't read stale device entries which were removed long ago
           but are still present in the defaults/registry on Mac and Windows.
           (This bug is in all other Pd versions out there. It only affects
           Mac and Windows, since the config information on Linux is kept in a
           file which is overwritten each time the config information is
           saved, so there are never any stale device entries in it.)
           Our code is fully compatible with config info from other Pd
           versions, i.e., we fall back to the default behavior of looking for
           up to MAXAUDIOINDEV devices if the naudioin key isn't set, and the
           naudioin key will just be ignored if our config happens to be read
           by other Pd versions. Audio outputs and MIDI inputs/outputs are
           handled in exactly the same fashion below. */
        int n;
        if (!(sys_getpreference("naudioin", prefbuf, MAXPDSTRING)
              && sscanf(prefbuf, "%d", &n) > 0))
            n = MAXAUDIOINDEV;
        for (i = 0, naudioindev = 0; i < n; i++)
Miller Puckette's avatar
Miller Puckette committed
536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553
        {
            sprintf(keybuf, "audioindev%d", i+1);
            if (!sys_getpreference(keybuf, prefbuf, MAXPDSTRING))
                break;
            if (sscanf(prefbuf, "%d %d", &audioindev[i], &chindev[i]) < 2)
                break;
            naudioindev++;
        }
            /* if no preferences at all, set -1 for default behavior */
        if (naudioindev == 0)
            naudioindev = -1;
    }
        /* JMZ/MB: brackets for initializing */
    if (sys_getpreference("noaudioout", prefbuf, MAXPDSTRING) &&
        (!strcmp(prefbuf, ".") || !strcmp(prefbuf, "True")))
            naudiooutdev = 0;
    else
    {
554 555 556 557 558 559
        /* AG: naudioout key */
        int n;
        if (!(sys_getpreference("naudioout", prefbuf, MAXPDSTRING)
              && sscanf(prefbuf, "%d", &n) > 0))
            n = MAXAUDIOOUTDEV;
        for (i = 0, naudiooutdev = 0; i < n; i++)
Miller Puckette's avatar
Miller Puckette committed
560 561 562 563 564 565 566 567 568 569 570 571 572 573 574
        {
            sprintf(keybuf, "audiooutdev%d", i+1);
            if (!sys_getpreference(keybuf, prefbuf, MAXPDSTRING))
                break;
            if (sscanf(prefbuf, "%d %d", &audiooutdev[i], &choutdev[i]) < 2)
                break;
            naudiooutdev++;
        }
        if (naudiooutdev == 0)
            naudiooutdev = -1;
    }
    if (sys_getpreference("rate", prefbuf, MAXPDSTRING))
        sscanf(prefbuf, "%d", &rate);
    if (sys_getpreference("audiobuf", prefbuf, MAXPDSTRING))
        sscanf(prefbuf, "%d", &advance);
Miller Puckette's avatar
Miller Puckette committed
575 576
    if (sys_getpreference("callback", prefbuf, MAXPDSTRING))
        sscanf(prefbuf, "%d", &callback);
577 578
    if (sys_getpreference("blocksize", prefbuf, MAXPDSTRING))
        sscanf(prefbuf, "%d", &blocksize);
579
    sys_set_audio_settings(naudioindev, audioindev, naudioindev, chindev,
Miller Puckette's avatar
Miller Puckette committed
580
        naudiooutdev, audiooutdev, naudiooutdev, choutdev, rate, advance,
581
        callback, blocksize);
Miller Puckette's avatar
Miller Puckette committed
582 583
        
        /* load MIDI preferences */
584 585 586
    if (sys_getpreference("midiapi", prefbuf, MAXPDSTRING)
        && sscanf(prefbuf, "%d", &api) > 0)
            sys_set_midi_api(api);
Miller Puckette's avatar
Miller Puckette committed
587 588 589 590
        /* JMZ/MB: brackets for initializing */
    if (sys_getpreference("nomidiin", prefbuf, MAXPDSTRING) &&
        (!strcmp(prefbuf, ".") || !strcmp(prefbuf, "True")))
            nmidiindev = 0;
591
    else
Miller Puckette's avatar
Miller Puckette committed
592
    {
593 594 595 596 597 598 599 600 601 602 603 604 605 606
        /* AG: nmidiin key */
        int n;
        if (!(sys_getpreference("nmidiin", prefbuf, MAXPDSTRING)
              && sscanf(prefbuf, "%d", &n) > 0))
            n = MAXMIDIINDEV;
        for (i = 0, nmidiindev = 0; i < n; i++)
        {
            sprintf(keybuf, "midiindev%d", i+1);
            if (!sys_getpreference(keybuf, prefbuf, MAXPDSTRING))
                break;
            if (sscanf(prefbuf, "%d", &midiindev[i]) < 1)
                break;
            nmidiindev++;
        }
Miller Puckette's avatar
Miller Puckette committed
607 608 609 610 611
    }
        /* JMZ/MB: brackets for initializing */
    if (sys_getpreference("nomidiout", prefbuf, MAXPDSTRING) &&
        (!strcmp(prefbuf, ".") || !strcmp(prefbuf, "True")))
            nmidioutdev = 0;
612
    else
Miller Puckette's avatar
Miller Puckette committed
613
    {
614 615 616 617 618 619 620 621 622 623 624 625 626 627
        /* AG: nmidiout key */
        int n;
        if (!(sys_getpreference("nmidiout", prefbuf, MAXPDSTRING)
              && sscanf(prefbuf, "%d", &n) > 0))
            n = MAXMIDIOUTDEV;
        for (i = 0, nmidioutdev = 0; i < n; i++)
        {
            sprintf(keybuf, "midioutdev%d", i+1);
            if (!sys_getpreference(keybuf, prefbuf, MAXPDSTRING))
                break;
            if (sscanf(prefbuf, "%d", &midioutdev[i]) < 1)
                break;
            nmidioutdev++;
        }
Miller Puckette's avatar
Miller Puckette committed
628 629 630 631 632 633 634 635 636 637 638 639
    }
    sys_open_midi(nmidiindev, midiindev, nmidioutdev, midioutdev, 0);

        /* search path */
    if (sys_getpreference("npath", prefbuf, MAXPDSTRING))
        sscanf(prefbuf, "%d", &maxi);
    else maxi = 0x7fffffff;
    for (i = 0; i<maxi; i++)
    {
        sprintf(keybuf, "path%d", i+1);
        if (!sys_getpreference(keybuf, prefbuf, MAXPDSTRING))
            break;
640 641 642 643 644 645 646 647
        else {
            // AG: need to expand ~ et al here
            char final_name[FILENAME_MAX];
            sys_expandpathelems(prefbuf, final_name);
            // AG: ignore non-existent paths
            if (!check_exists(final_name))
                continue;
	}
Miller Puckette's avatar
Miller Puckette committed
648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667
        sys_searchpath = namelist_append_files(sys_searchpath, prefbuf);
    }
    if (sys_getpreference("standardpath", prefbuf, MAXPDSTRING))
        sscanf(prefbuf, "%d", &sys_usestdpath);
    if (sys_getpreference("verbose", prefbuf, MAXPDSTRING))
        sscanf(prefbuf, "%d", &sys_verbose);

        /* startup settings */
    if (sys_getpreference("nloadlib", prefbuf, MAXPDSTRING))
        sscanf(prefbuf, "%d", &maxi);
    else maxi = 0x7fffffff;
    for (i = 0; i<maxi; i++)
    {
        sprintf(keybuf, "loadlib%d", i+1);
        if (!sys_getpreference(keybuf, prefbuf, MAXPDSTRING))
            break;
        sys_externlist = namelist_append_files(sys_externlist, prefbuf);
    }
    if (sys_getpreference("defeatrt", prefbuf, MAXPDSTRING))
        sscanf(prefbuf, "%d", &sys_defeatrt);
668 669
    if (sys_getpreference("savezoom", prefbuf, MAXPDSTRING))
        sscanf(prefbuf, "%d", &sys_zoom);
670
    if (sys_getpreference("guipreset", prefbuf, MAXPDSTRING))
671 672 673 674 675
    {
        char preset_buf[MAXPDSTRING];
        sscanf(prefbuf, "%s", preset_buf);
        sys_gui_preset = gensym(preset_buf);
    }
Miller Puckette's avatar
Miller Puckette committed
676 677 678 679 680
    if (sys_getpreference("flags", prefbuf, MAXPDSTRING))
    {
        if (strcmp(prefbuf, "."))
            sys_flags = gensym(prefbuf);
    }
681
    sys_doneloadpreferences();
Miller Puckette's avatar
Miller Puckette committed
682 683 684 685 686 687
    sys_doflags();

    if (sys_defeatrt)
        sys_hipriority = 0;
    else
#ifdef UNIX
688
        sys_hipriority = 1; //!geteuid();
Miller Puckette's avatar
Miller Puckette committed
689 690 691 692 693 694 695 696 697 698 699 700 701
#else
#ifdef MSW
        sys_hipriority = 0;
#else
        sys_hipriority = 1;
#endif
#endif
}

void glob_savepreferences(t_pd *dummy)
{
    int naudioindev, audioindev[MAXAUDIOINDEV], chindev[MAXAUDIOINDEV];
    int naudiooutdev, audiooutdev[MAXAUDIOOUTDEV], choutdev[MAXAUDIOOUTDEV];
702
    int i, rate, advance, callback, blocksize;
Miller Puckette's avatar
Miller Puckette committed
703 704 705 706 707 708 709 710 711 712 713 714
    char buf1[MAXPDSTRING], buf2[MAXPDSTRING];
    int nmidiindev, midiindev[MAXMIDIINDEV];
    int nmidioutdev, midioutdev[MAXMIDIOUTDEV];

    sys_initsavepreferences();


        /* audio settings */
    sprintf(buf1, "%d", sys_audioapi);
    sys_putpreference("audioapi", buf1);

    sys_get_audio_params(&naudioindev, audioindev, chindev,
715 716
        &naudiooutdev, audiooutdev, choutdev, &rate, &advance, &callback,
            &blocksize);
Miller Puckette's avatar
Miller Puckette committed
717 718

    sys_putpreference("noaudioin", (naudioindev <= 0 ? "True" : "False"));
719 720 721 722
    /* AG: additional naudioin key, see the comments in sys_loadpreferences
       above for explanation */
    sprintf(buf1, "%d", naudioindev);
    sys_putpreference("naudioin", buf1);
Miller Puckette's avatar
Miller Puckette committed
723 724 725 726 727 728 729
    for (i = 0; i < naudioindev; i++)
    {
        sprintf(buf1, "audioindev%d", i+1);
        sprintf(buf2, "%d %d", audioindev[i], chindev[i]);
        sys_putpreference(buf1, buf2);
    }
    sys_putpreference("noaudioout", (naudiooutdev <= 0 ? "True" : "False"));
730 731 732
    /* AG: naudioout key */
    sprintf(buf1, "%d", naudiooutdev);
    sys_putpreference("naudioout", buf1);
Miller Puckette's avatar
Miller Puckette committed
733 734 735 736 737 738 739 740 741 742 743 744 745
    for (i = 0; i < naudiooutdev; i++)
    {
        sprintf(buf1, "audiooutdev%d", i+1);
        sprintf(buf2, "%d %d", audiooutdev[i], choutdev[i]);
        sys_putpreference(buf1, buf2);
   }

    sprintf(buf1, "%d", advance);
    sys_putpreference("audiobuf", buf1);

    sprintf(buf1, "%d", rate);
    sys_putpreference("rate", buf1);

Miller Puckette's avatar
Miller Puckette committed
746 747 748
    sprintf(buf1, "%d", callback);
    sys_putpreference("callback", buf1);

749 750 751
    sprintf(buf1, "%d", blocksize);
    sys_putpreference("blocksize", buf1);

Miller Puckette's avatar
Miller Puckette committed
752
        /* MIDI settings */
753 754 755
    sprintf(buf1, "%d", sys_midiapi);
    sys_putpreference("midiapi", buf1);

Miller Puckette's avatar
Miller Puckette committed
756 757
    sys_get_midi_params(&nmidiindev, midiindev, &nmidioutdev, midioutdev);
    sys_putpreference("nomidiin", (nmidiindev <= 0 ? "True" : "False"));
758 759 760
    /* AG: nmidiin */
    sprintf(buf1, "%d", nmidiindev);
    sys_putpreference("nmidiin", buf1);
Miller Puckette's avatar
Miller Puckette committed
761 762 763 764 765 766 767
    for (i = 0; i < nmidiindev; i++)
    {
        sprintf(buf1, "midiindev%d", i+1);
        sprintf(buf2, "%d", midiindev[i]);
        sys_putpreference(buf1, buf2);
    }
    sys_putpreference("nomidiout", (nmidioutdev <= 0 ? "True" : "False"));
768 769 770
    /* AG: nmidiout */
    sprintf(buf1, "%d", nmidioutdev);
    sys_putpreference("nmidiout", buf1);
Miller Puckette's avatar
Miller Puckette committed
771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806
    for (i = 0; i < nmidioutdev; i++)
    {
        sprintf(buf1, "midioutdev%d", i+1);
        sprintf(buf2, "%d", midioutdev[i]);
        sys_putpreference(buf1, buf2);
    }
        /* file search path */

    for (i = 0; 1; i++)
    {
        char *pathelem = namelist_get(sys_searchpath, i);
        if (!pathelem)
            break;
        sprintf(buf1, "path%d", i+1);
        sys_putpreference(buf1, pathelem);
    }
    sprintf(buf1, "%d", i);
    sys_putpreference("npath", buf1);
    sprintf(buf1, "%d", sys_usestdpath);
    sys_putpreference("standardpath", buf1);
    sprintf(buf1, "%d", sys_verbose);
    sys_putpreference("verbose", buf1);
    
        /* startup */
    for (i = 0; 1; i++)
    {
        char *pathelem = namelist_get(sys_externlist, i);
        if (!pathelem)
            break;
        sprintf(buf1, "loadlib%d", i+1);
        sys_putpreference(buf1, pathelem);
    }
    sprintf(buf1, "%d", i);
    sys_putpreference("nloadlib", buf1);
    sprintf(buf1, "%d", sys_defeatrt);
    sys_putpreference("defeatrt", buf1);
807 808
    sprintf(buf1, "%d", sys_zoom);
    sys_putpreference("savezoom", buf1);
809
    sys_putpreference("guipreset", sys_gui_preset->s_name);
Miller Puckette's avatar
Miller Puckette committed
810 811 812 813 814
    sys_putpreference("flags", 
        (sys_flags ? sys_flags->s_name : ""));
    sys_donesavepreferences();
    
}
815 816 817 818 819 820 821 822 823 824

/* AG: Recent files table */

int sys_n_recent_files = 0;
char *sys_recent_files[MAX_RECENT_FILES];

void sys_add_recent_file(const char *s)
{
  int i;
  // only add the file if it actually exists
825
  if (!check_exists(s)) return;
826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855
  for (i = 0; i < sys_n_recent_files && strcmp(sys_recent_files[i], s); i++) ;
  if (i < sys_n_recent_files) {
    // already got an existing entry, move it to the front
    char *t = sys_recent_files[i];
    memmove(sys_recent_files+1, sys_recent_files, i*sizeof(char*));
    sys_recent_files[0] = t;
  } else {
    char *t = strdup(s);
    if (!t) return;
    if (sys_n_recent_files == MAX_RECENT_FILES) {
      // kick out the oldest entry to make room for a new one
      free(sys_recent_files[--sys_n_recent_files]);
    }
    // add a new entry at the beginning of the table
    memmove(sys_recent_files+1, sys_recent_files,
            sys_n_recent_files*sizeof(char*));
    sys_recent_files[0] = t;
    sys_n_recent_files++;
  }
}

void sys_save_recent_files(void)
{
  int i;
#ifdef UNIX
  // UNIX/Linux: save in recent_files file
  FILE *fp;
  char filenamebuf[FILENAME_MAX], *homedir = getenv("HOME");
  struct stat statbuf;
  if (!homedir) return;
856
  snprintf(filenamebuf, FILENAME_MAX, "%s/" USER_CONFIG_DIR, homedir);
857 858 859 860 861 862 863 864
  filenamebuf[FILENAME_MAX-1] = 0;
  if (stat(filenamebuf, &statbuf) || !S_ISDIR(statbuf.st_mode)) {
    // user config dir doesn't exist yet, try to create it
    if (mkdir(filenamebuf, 0755)) {
      pd_error(0, "%s: %s",filenamebuf, strerror(errno));
      return;
    }
  }
865
  snprintf(filenamebuf, FILENAME_MAX, "%s/" USER_CONFIG_DIR "/recent_files", homedir);
866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895
  filenamebuf[FILENAME_MAX-1] = 0;
  if ((fp = fopen(filenamebuf, "w")) == NULL) {
    pd_error(0, "%s: %s",filenamebuf, strerror(errno));
    return;
  }
  for (i = 0; i < sys_n_recent_files; i++) {
    fprintf(fp, "%s\n", sys_recent_files[i]);
  }
  fclose(fp);
#else
  // Mac/Windows (use the defaults/registry)
  char buf[MAXPDSTRING];
  sys_initsavepreferences();
  for (i = 0; i < sys_n_recent_files; i++) {
    sprintf(buf, "recent%d", i+1);
    sys_putpreference(buf, sys_recent_files[i]);
  }
  sprintf(buf, "%d", i);
  sys_putpreference("nrecent", buf);
  sys_donesavepreferences();
#endif
}

void sys_load_recent_files(void)
{
#ifdef UNIX
  // UNIX/Linux: load from recent_files file
  FILE *fp;
  char filenamebuf[FILENAME_MAX], *homedir = getenv("HOME");
  if (!homedir) return;
896
  snprintf(filenamebuf, FILENAME_MAX, "%s/" USER_CONFIG_DIR "/recent_files", homedir);
897 898 899 900 901 902 903 904
  filenamebuf[FILENAME_MAX-1] = 0;
  if ((fp = fopen(filenamebuf, "r")) == NULL) return;
  for (sys_n_recent_files = 0; sys_n_recent_files < MAX_RECENT_FILES &&
         fgets(filenamebuf, FILENAME_MAX, fp); ) {
    char *s;
    int l = strlen(filenamebuf);
    if (l > 0 && filenamebuf[l-1] == '\n') filenamebuf[--l] = 0;
    // only add files which actually exist
905
    if (l == 0 || !check_exists(filenamebuf)) continue;
906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923
    s = strdup(filenamebuf);
    if (s) sys_recent_files[sys_n_recent_files++] = s;
  }
  fclose(fp);
#else
  // Mac/Windows (use the defaults/registry)
  char prefbuf[MAXPDSTRING], keybuf[80];
  int i, maxi = MAX_RECENT_FILES;
  sys_initloadpreferences();
  if (sys_getpreference("nrecent", prefbuf, MAXPDSTRING))
    sscanf(prefbuf, "%d", &maxi);
  for (i = 0; i < maxi; i++) {
    int l;
    char *s;
    sprintf(keybuf, "recent%d", i+1);
    if (!sys_getpreference(keybuf, prefbuf, MAXPDSTRING))
      break;
    l = strlen(prefbuf);
924
    if (l == 0 || !check_exists(prefbuf)) continue;
925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970
    s = strdup(prefbuf);
    if (s) sys_recent_files[sys_n_recent_files++] = s;
  }
  sys_doneloadpreferences();
#endif
}

void sys_clear_recent_files(void)
{
  int i;
  for (i = 0; i < sys_n_recent_files; i++) {
    free(sys_recent_files[i]);
  }
  sys_n_recent_files = 0;
}

// send the recent files list back to the gui so that the Recent Files menu
// can be updated accordingly
void glob_recent_files(t_pd *dummy)
{
    int i;
    gui_start_vmess("gui_recent_files", "x", dummy);
    gui_start_array();
    for (i = 0; i < sys_n_recent_files; i++)
    {
        gui_s(sys_recent_files[i]);
    }
    gui_end_array();
    gui_end_vmess();
}

// add an entry to the recent files list, save the list and update the gui
void glob_add_recent_file(t_pd *dummy, t_symbol *s)
{
    sys_add_recent_file(s->s_name);
    sys_save_recent_files();
    glob_recent_files(dummy);
}

// clear the recent files list, save the list and update the gui
void glob_clear_recent_files(t_pd *dummy)
{
    sys_clear_recent_files();
    sys_save_recent_files();
    glob_recent_files(dummy);
}