* lisp.h (struct Lisp_Symbol): Replace field "name" with a lisp
[bpt/emacs.git] / src / dosfns.c
index 59fdd67..428bde8 100644 (file)
@@ -1,6 +1,7 @@
 /* MS-DOS specific Lisp utilities.  Coded by Manabu Higashida, 1991.
    Major changes May-July 1993 Morten Welinder (only 10% original code left)
-   Copyright (C) 1991, 1993, 1996, 1997 Free Software Foundation, Inc.
+   Copyright (C) 1991, 1993, 1996, 1997, 1998, 2001
+   Free Software Foundation, Inc.
 
 This file is part of GNU Emacs.
 
@@ -19,7 +20,6 @@ along with GNU Emacs; see the file COPYING.  If not, write to
 the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
 Boston, MA 02111-1307, USA.  */
 
-
 #include <config.h>
 
 #ifdef MSDOS
@@ -38,36 +38,39 @@ Boston, MA 02111-1307, USA.  */
 #include "dosfns.h"
 #include "msdos.h"
 #include "dispextern.h"
+#include "charset.h"
+#include "coding.h"
 #include <dpmi.h>
 #include <go32.h>
 #include <dirent.h>
+#include <sys/vfs.h>
 
 #ifndef __DJGPP_MINOR__
 # define __tb _go32_info_block.linear_address_of_transfer_buffer;
 #endif
 
 DEFUN ("int86", Fint86, Sint86, 2, 2, 0,
-  "Call specific MSDOS interrupt number INTERRUPT with REGISTERS.\n\
-Return the updated REGISTER vector.\n\
-\n\
-INTERRUPT should be an integer in the range 0 to 255.\n\
-REGISTERS should be a vector produced by `make-register' and\n\
-`set-register-value'.")
-  (interrupt, registers)
-  Lisp_Object interrupt, registers;
+       doc: /* Call specific MSDOS interrupt number INTERRUPT with REGISTERS.
+Return the updated REGISTER vector.
+
+INTERRUPT should be an integer in the range 0 to 255.
+REGISTERS should be a vector produced by `make-register' and
+`set-register-value'.  */)
+     (interrupt, registers)
+     Lisp_Object interrupt, registers;
 {
   register int i;
   int no;
   union REGS inregs, outregs;
   Lisp_Object val;
 
-  CHECK_NUMBER (interrupt, 0);
+  CHECK_NUMBER (interrupt);
   no = (unsigned long) XINT (interrupt);
-  CHECK_VECTOR (registers, 1);
-  if (no < 0 || no > 0xff || XVECTOR (registers)-> size != 8) 
+  CHECK_VECTOR (registers);
+  if (no < 0 || no > 0xff || XVECTOR (registers)-> size != 8)
     return Qnil;
   for (i = 0; i < 8; i++)
-    CHECK_NUMBER (XVECTOR (registers)->contents[i], 1);
+    CHECK_NUMBER (XVECTOR (registers)->contents[i]);
 
   inregs.x.ax    = (unsigned long) XFASTINT (XVECTOR (registers)->contents[0]);
   inregs.x.bx    = (unsigned long) XFASTINT (XVECTOR (registers)->contents[1]);
@@ -93,25 +96,25 @@ REGISTERS should be a vector produced by `make-register' and\n\
 }
 
 DEFUN ("msdos-memget", Fdos_memget, Sdos_memget, 2, 2, 0,
-  "Read DOS memory at offset ADDRESS into VECTOR.\n\
-Return the updated VECTOR.")
-  (address, vector)
-  Lisp_Object address, vector;
+       doc: /* Read DOS memory at offset ADDRESS into VECTOR.
+Return the updated VECTOR.  */)
+     (address, vector)
+     Lisp_Object address, vector;
 {
   register int i;
   int offs, len;
   char *buf;
   Lisp_Object val;
 
-  CHECK_NUMBER (address, 0);
+  CHECK_NUMBER (address);
   offs = (unsigned long) XINT (address);
-  CHECK_VECTOR (vector, 1);
+  CHECK_VECTOR (vector);
   len = XVECTOR (vector)-> size;
-  if (len < 1 || len > 2048 || address < 0 || address > 0xfffff - len) 
+  if (len < 1 || len > 2048 || address < 0 || address > 0xfffff - len)
     return Qnil;
   buf = alloca (len);
   dosmemget (offs, len, buf);
-  
+
   for (i = 0; i < len; i++)
     XVECTOR (vector)->contents[i] = make_number (buf[i]);
 
@@ -119,26 +122,26 @@ Return the updated VECTOR.")
 }
 
 DEFUN ("msdos-memput", Fdos_memput, Sdos_memput, 2, 2, 0,
-  "Write DOS memory at offset ADDRESS from VECTOR.")
-  (address, vector)
-  Lisp_Object address, vector;
+       doc: /* Write DOS memory at offset ADDRESS from VECTOR.  */)
+     (address, vector)
+     Lisp_Object address, vector;
 {
   register int i;
   int offs, len;
   char *buf;
   Lisp_Object val;
 
-  CHECK_NUMBER (address, 0);
+  CHECK_NUMBER (address);
   offs = (unsigned long) XINT (address);
-  CHECK_VECTOR (vector, 1);
+  CHECK_VECTOR (vector);
   len = XVECTOR (vector)-> size;
-  if (len < 1 || len > 2048 || address < 0 || address > 0xfffff - len) 
+  if (len < 1 || len > 2048 || address < 0 || address > 0xfffff - len)
     return Qnil;
   buf = alloca (len);
 
   for (i = 0; i < len; i++)
     {
-      CHECK_NUMBER (XVECTOR (vector)->contents[i], 1);
+      CHECK_NUMBER (XVECTOR (vector)->contents[i]);
       buf[i] = (unsigned char) XFASTINT (XVECTOR (vector)->contents[i]) & 0xFF;
     }
 
@@ -147,14 +150,14 @@ DEFUN ("msdos-memput", Fdos_memput, Sdos_memput, 2, 2, 0,
 }
 
 DEFUN ("msdos-set-keyboard", Fmsdos_set_keyboard, Smsdos_set_keyboard, 1, 2, 0,
-  "Set keyboard layout according to COUNTRY-CODE.\n\
-If the optional argument ALLKEYS is non-nil, the keyboard is mapped for\n\
-all keys; otherwise it is only used when the ALT key is pressed.\n\
-The current keyboard layout is available in dos-keyboard-code.")
-  (country_code, allkeys)
-  Lisp_Object country_code;
+       doc: /* Set keyboard layout according to COUNTRY-CODE.
+If the optional argument ALLKEYS is non-nil, the keyboard is mapped for
+all keys; otherwise it is only used when the ALT key is pressed.
+The current keyboard layout is available in dos-keyboard-code.  */)
+     (country_code, allkeys)
+     Lisp_Object country_code;
 {
-  CHECK_NUMBER (country_code, 0);
+  CHECK_NUMBER (country_code);
   if (!dos_set_keyboard (XINT (country_code), !NILP (allkeys)))
     return Qnil;
   return Qt;
@@ -164,8 +167,8 @@ The current keyboard layout is available in dos-keyboard-code.")
 /* Later we might want to control the mouse interface with this function,
    e.g., with respect to non-80 column screen modes.  */
 
-DEFUN ("msdos-mouse-p", Fmsdos_mouse_p, Smsdos_mouse_p, 0, 0, 0, "\
-Report whether a mouse is present.")
+DEFUN ("msdos-mouse-p", Fmsdos_mouse_p, Smsdos_mouse_p, 0, 0, 0,
+       doc: /* Report whether a mouse is present.  */)
      ()
 {
   if (have_mouse)
@@ -173,17 +176,11 @@ Report whether a mouse is present.")
   else
     return Qnil;
 }
-
-/* Function to translate colour names to integers.  See lisp/term/pc-win.el
-   for its definition.  */
-
-Lisp_Object Qmsdos_color_translate;
 #endif
 
-
 DEFUN ("msdos-mouse-init", Fmsdos_mouse_init, Smsdos_mouse_init, 0, 0, "",
-  "Initialize and enable mouse if available.")
-  ()
+       doc: /* Initialize and enable mouse if available.  */)
+     ()
 {
   if (have_mouse)
     {
@@ -195,8 +192,8 @@ DEFUN ("msdos-mouse-init", Fmsdos_mouse_init, Smsdos_mouse_init, 0, 0, "",
 }
 
 DEFUN ("msdos-mouse-enable", Fmsdos_mouse_enable, Smsdos_mouse_enable, 0, 0, "",
-  "Enable mouse if available.")
-  ()
+       doc: /* Enable mouse if available.  */)
+     ()
 {
   if (have_mouse)
     {
@@ -207,26 +204,25 @@ DEFUN ("msdos-mouse-enable", Fmsdos_mouse_enable, Smsdos_mouse_enable, 0, 0, "",
 }
 
 DEFUN ("msdos-mouse-disable", Fmsdos_mouse_disable, Smsdos_mouse_disable, 0, 0, "",
-  "Disable mouse if available.")
-  ()
+       doc: /* Disable mouse if available.  */)
+     ()
 {
   mouse_off ();
   if (have_mouse) have_mouse = -1;
   return Qnil;
 }
 
-DEFUN ("insert-startup-screen", Finsert_startup_screen, Sinsert_startup_screen, 0, 0, "", "\
-Insert copy of screen contents prior to starting emacs.\n\
-Return nil if startup screen is not available.")
-  ()
+DEFUN ("insert-startup-screen", Finsert_startup_screen, Sinsert_startup_screen, 0, 0, "",
+       doc: /* Insert copy of screen contents prior to starting emacs.
+Return nil if startup screen is not available.  */)
+     ()
 {
   char *s;
-  int rows, cols;
-  int i, j;
-  
+  int rows, cols, i, j;
+
   if (!dos_get_saved_screen (&s, &rows, &cols))
     return Qnil;
-  
+
   for (i = 0; i < rows; i++)
     {
       for (j = 0; j < cols; j++)
@@ -241,11 +237,11 @@ Return nil if startup screen is not available.")
 }
 \f
 /* country info */
-int dos_country_code;
-int dos_codepage;
-int dos_timezone_offset;
-int dos_decimal_point;
-int dos_keyboard_layout;
+EMACS_INT dos_country_code;
+EMACS_INT dos_codepage;
+EMACS_INT dos_timezone_offset;
+EMACS_INT dos_decimal_point;
+EMACS_INT dos_keyboard_layout;
 unsigned char dos_country_info[DOS_COUNTRY_INFO];
 static unsigned char usa_country_info[DOS_COUNTRY_INFO] = {
   0, 0,                                /* date format */
@@ -262,9 +258,9 @@ static unsigned char usa_country_info[DOS_COUNTRY_INFO] = {
   0, 0, 0, 0, 0, 0, 0, 0, 0, 0 /* reserved */
 };
 
-int dos_hyper_key;
-int dos_super_key;
-int dos_keypad_mode;
+EMACS_INT dos_hyper_key;
+EMACS_INT dos_super_key;
+EMACS_INT dos_keypad_mode;
 
 Lisp_Object Vdos_version;
 Lisp_Object Vdos_display_scancodes;
@@ -286,7 +282,7 @@ restore_parent_vm_title (void)
   delay (50);
 }
 #endif /* !HAVE_X_WINDOWS */
-  
+
 void
 init_dosfns ()
 {
@@ -325,7 +321,7 @@ init_dosfns ()
   intdos (&regs, &regs);
   if (regs.x.cflag)
     /* Estimate code page from country code */
-    switch (dos_country_code) 
+    switch (dos_country_code)
       {
       case 45: /* Denmark */
       case 47: /* Norway */
@@ -418,8 +414,8 @@ static char *vga_colors[16] = {
    that this only performs case-insensitive comparison against the
    standard names.  For anything more sophisticated, like matching
    "gray" with "grey" or translating X color names into their MSDOS
-   equivalents, call the Lisp function Qmsdos_color_translate (defined
-   on lisp/term/pc-win.el).  */
+   equivalents, call the Lisp function Qtty_color_desc (defined
+   on lisp/term/tty-colors.el).  */
 int
 msdos_stdcolor_idx (const char *name)
 {
@@ -429,16 +425,26 @@ msdos_stdcolor_idx (const char *name)
     if (strcasecmp (name, vga_colors[i]) == 0)
       return i;
 
-  return FACE_TTY_DEFAULT_COLOR;
+  return
+    strcmp (name, unspecified_fg) == 0 ? FACE_TTY_DEFAULT_FG_COLOR
+    : strcmp (name, unspecified_bg) == 0 ? FACE_TTY_DEFAULT_BG_COLOR
+    : FACE_TTY_DEFAULT_COLOR;
 }
 
 /* Given a color index, return its standard name.  */
-char *
+Lisp_Object
 msdos_stdcolor_name (int idx)
 {
-  if (idx < 0 || idx >= sizeof (vga_colors) / sizeof (vga_colors[0]))
-    return ""; /* meaning the default */
-  return vga_colors[idx];
+  extern Lisp_Object Qunspecified;
+
+  if (idx == FACE_TTY_DEFAULT_FG_COLOR)
+    return build_string (unspecified_fg);
+  else if (idx == FACE_TTY_DEFAULT_BG_COLOR)
+    return build_string (unspecified_bg);
+  else if (idx >= 0 && idx < sizeof (vga_colors) / sizeof (vga_colors[0]))
+    return build_string (vga_colors[idx]);
+  else
+    return Qunspecified;       /* meaning the default */
 }
 
 /* Support for features that are available when we run in a DOS box
@@ -503,6 +509,32 @@ x_set_title (f, name)
 }
 #endif /* !HAVE_X_WINDOWS */
 \f
+DEFUN ("file-system-info", Ffile_system_info, Sfile_system_info, 1, 1, 0,
+       doc: /* Return storage information about the file system FILENAME is on.
+Value is a list of floats (TOTAL FREE AVAIL), where TOTAL is the total
+storage of the file system, FREE is the free storage, and AVAIL is the
+storage available to a non-superuser.  All 3 numbers are in bytes.
+If the underlying system call fails, value is nil.  */)
+     (filename)
+     Lisp_Object filename;
+{
+  struct statfs stfs;
+  Lisp_Object encoded, value;
+
+  CHECK_STRING (filename);
+  filename = Fexpand_file_name (filename, Qnil);
+  encoded = ENCODE_FILE (filename);
+
+  if (statfs (XSTRING (encoded)->data, &stfs))
+    value = Qnil;
+  else
+    value = list3 (make_float ((double) stfs.f_bsize * stfs.f_blocks),
+                  make_float ((double) stfs.f_bsize * stfs.f_bfree),
+                  make_float ((double) stfs.f_bsize * stfs.f_bavail));
+
+  return value;
+}
+\f
 void
 dos_cleanup (void)
 {
@@ -531,89 +563,91 @@ syms_of_dosfns ()
   defsubr (&Smsdos_set_keyboard);
   defsubr (&Sinsert_startup_screen);
   defsubr (&Smsdos_mouse_disable);
+  defsubr (&Sfile_system_info);
 #ifndef HAVE_X_WINDOWS
   defsubr (&Smsdos_mouse_p);
-  Qmsdos_color_translate = intern ("msdos-color-translate");
-  staticpro (&Qmsdos_color_translate);
 #endif
 
   DEFVAR_INT ("dos-country-code", &dos_country_code,
-    "The country code returned by Dos when Emacs was started.\n\
-Usually this is the international telephone prefix.");
+             doc: /* The country code returned by Dos when Emacs was started.
+Usually this is the international telephone prefix.  */);
 
   DEFVAR_INT ("dos-codepage", &dos_codepage,
-    "The codepage active when Emacs was started.\n\
-The following are known:\n\
-       437     United States\n\
-       850     Multilingual (Latin I)\n\
-       852     Slavic (Latin II)\n\
-       857     Turkish\n\
-       860     Portugal\n\
-       861     Iceland\n\
-       863     Canada (French)\n\
-       865     Norway/Denmark");
+             doc: /* The codepage active when Emacs was started.
+The following are known:
+       437     United States
+       850     Multilingual (Latin I)
+       852     Slavic (Latin II)
+       857     Turkish
+       860     Portugal
+       861     Iceland
+       863     Canada (French)
+       865     Norway/Denmark  */);
 
   DEFVAR_INT ("dos-timezone-offset", &dos_timezone_offset,
-    "The current timezone offset to UTC in minutes.
-Implicitly modified when the TZ variable is changed.");
-  
+             doc: /* The current timezone offset to UTC in minutes.
+Implicitly modified when the TZ variable is changed.  */);
+
   DEFVAR_LISP ("dos-version", &Vdos_version,
-    "The (MAJOR . MINOR) Dos version (subject to modification with setver).");
+              doc: /* The (MAJOR . MINOR) Dos version (subject to modification with setver).  */);
 
 #ifndef HAVE_X_WINDOWS
   DEFVAR_LISP ("dos-windows-version", &Vdos_windows_version,
-    "The (MAJOR . MINOR) Windows version for DOS session on MS-Windows.");
+              doc: /* The (MAJOR . MINOR) Windows version for DOS session on MS-Windows.  */);
 #endif
 
   DEFVAR_LISP ("dos-display-scancodes", &Vdos_display_scancodes,
-    "*When non-nil, the keyboard scan-codes are displayed at the bottom right\n\
-corner of the display (typically at the end of the mode line).\n\
-The output format is: scan code:char code*modifiers.");
+              doc: /* *Controls whether DOS raw keyboard events are displayed as you type.
+When non-nil, the keyboard scan-codes are displayed at the bottom right
+corner of the display (typically at the end of the mode line).
+The output format is: scan code:char code*modifiers.  */);
+
   Vdos_display_scancodes = Qnil;
-  
+
   DEFVAR_INT ("dos-hyper-key", &dos_hyper_key,
-    "*If set to 1, use right ALT key as hyper key.\n\
-If set to 2, use right CTRL key as hyper key.");
+             doc: /* *If set to 1, use right ALT key as hyper key.
+If set to 2, use right CTRL key as hyper key.  */);
   dos_hyper_key = 0;
-  
+
   DEFVAR_INT ("dos-super-key", &dos_super_key,
-    "*If set to 1, use right ALT key as super key.\n\
-If set to 2, use right CTRL key as super key.");
+             doc: /* *If set to 1, use right ALT key as super key.
+If set to 2, use right CTRL key as super key.  */);
   dos_super_key = 0;
-  
+
   DEFVAR_INT ("dos-keypad-mode", &dos_keypad_mode,
-    "*Controls what key code is returned by a key in the numeric keypad.\n\
-The `numlock ON' action is only taken if no modifier keys are pressed.\n\
-The value is an integer constructed by adding the following bits together:\n\
- \n\
-  0x00 Digit key returns digit    (if numlock ON)\n\
-  0x01 Digit key returns kp-digit (if numlock ON)\n\
-  0x02 Digit key returns M-digit  (if numlock ON)\n\
-  0x03 Digit key returns edit key (if numlock ON)\n\
- \n\
-  0x00 Grey key returns char      (if numlock ON)\n\
-  0x04 Grey key returns kp-key    (if numlock ON)\n\
- \n\
-  0x00 Digit key returns digit    (if numlock OFF)\n\
-  0x10 Digit key returns kp-digit (if numlock OFF)\n\
-  0x20 Digit key returns M-digit  (if numlock OFF)\n\
-  0x30 Digit key returns edit key (if numlock OFF)\n\
- \n\
-  0x00 Grey key returns char      (if numlock OFF)\n\
-  0x40 Grey key returns kp-key    (if numlock OFF)\n\
- \n\
-  0x200        ALT-0..ALT-9 in top-row produces shifted codes.");
+             doc: /* *Controls what key code is returned by a key in the numeric keypad.
+The `numlock ON' action is only taken if no modifier keys are pressed.
+The value is an integer constructed by adding the following bits together:
+
+  0x00 Digit key returns digit    (if numlock ON)
+  0x01 Digit key returns kp-digit (if numlock ON)
+  0x02 Digit key returns M-digit  (if numlock ON)
+  0x03 Digit key returns edit key (if numlock ON)
+
+  0x00 Grey key returns char      (if numlock ON)
+  0x04 Grey key returns kp-key    (if numlock ON)
+
+  0x00 Digit key returns digit    (if numlock OFF)
+  0x10 Digit key returns kp-digit (if numlock OFF)
+  0x20 Digit key returns M-digit  (if numlock OFF)
+  0x30 Digit key returns edit key (if numlock OFF)
+
+  0x00 Grey key returns char      (if numlock OFF)
+  0x40 Grey key returns kp-key    (if numlock OFF)
+
+  0x200        ALT-0..ALT-9 in top-row produces shifted codes.  */);
   dos_keypad_mode = 0x75;
-  
+
   DEFVAR_INT ("dos-keyboard-layout", &dos_keyboard_layout,
-    "Contains the country code for the current keyboard layout.\n\
-Use msdos-set-keyboard to select another keyboard layout.");
+             doc: /* Contains the country code for the current keyboard layout.
+Use msdos-set-keyboard to select another keyboard layout.  */);
   dos_keyboard_layout = 1;     /* US */
-  
+
   DEFVAR_INT ("dos-decimal-point", &dos_decimal_point,
-    "If non-zero, it contains the character to be returned when the\n\
-decimal point key in the numeric keypad is pressed when Num Lock is on.\n\
-If zero, the decimal point key returns the country code specific value.");
+             doc: /* The character to produce when kp-decimal key is pressed.
+If non-zero, this variable contains the character to be returned when the
+decimal point key in the numeric keypad is pressed when Num Lock is on.
+If zero, the decimal point key returns the country code specific value.  */);
   dos_decimal_point = 0;
 }
 #endif /* MSDOS */