* Make sure that parameter errors are reported correctly.
[bpt/guile.git] / libguile / strorder.c
index 23c74c3..adea5de 100644 (file)
@@ -1,4 +1,4 @@
-/*     Copyright (C) 1995, 1996, 1999 Free Software Foundation, Inc.
+/*     Copyright (C) 1995, 1996, 1999, 2000 Free Software Foundation, Inc.
  * 
  * This program is free software; you can redistribute it and/or modify
  * it under the terms of the GNU General Public License as published by
 \f
 
 #include <stdio.h>
-#include "_scm.h"
-#include "chars.h"
+#include "libguile/_scm.h"
+#include "libguile/chars.h"
+#include "libguile/strings.h"
+#include "libguile/symbols.h"
 
-#include "scm_validate.h"
-#include "strorder.h"
+#include "libguile/validate.h"
+#include "libguile/strorder.h"
 \f
 
-GUILE_PROC1 (scm_string_equal_p, "string=?", scm_tc7_rpsubr,
+SCM_DEFINE1 (scm_string_equal_p, "string=?", scm_tc7_rpsubr,
              (SCM s1, SCM s2),
-"")
+            "Lexicographic equality predicate; \n"
+            "Returns @t{#t} if the two strings are the same length and contain the same\n"
+            "characters in the same positions, otherwise returns @t{#f}. (r5rs)\n\n"
+            "@samp{String-ci=?} treats\n"
+            "upper and lower case letters as though they were the same character, but\n"
+            "@samp{string=?} treats upper and lower case as distinct characters.")
 #define FUNC_NAME s_scm_string_equal_p
 {
-  register scm_sizet i;
-  register unsigned char *c1, *c2;
-  SCM_VALIDATE_ROSTRING (1,s1);
-  SCM_VALIDATE_ROSTRING (2,s2);
+  scm_sizet length;
 
-  i = SCM_ROLENGTH (s2);
-  if (SCM_ROLENGTH (s1) != i)
+  SCM_VALIDATE_STRING (1, s1);
+  SCM_VALIDATE_STRING (2, s2);
+
+  length = SCM_STRING_LENGTH (s2);
+  if (SCM_STRING_LENGTH (s1) == length)
     {
-      return SCM_BOOL_F;
+      unsigned char *c1 = SCM_STRING_UCHARS (s1) + length - 1;
+      unsigned char *c2 = SCM_STRING_UCHARS (s2) + length - 1;
+      scm_sizet i;
+
+      /* comparing from back to front typically finds mismatches faster */
+      for (i = 0; i != length; ++i, --c1, --c2)
+       if (*c1 != *c2)
+         return SCM_BOOL_F;
+
+      return SCM_BOOL_T;
     }
-  c1 = SCM_ROUCHARS (s1);
-  c2 = SCM_ROUCHARS (s2);
-  while (0 != i--)
-    if (*c1++ != *c2++)
+  else
+    {
       return SCM_BOOL_F;
-  return SCM_BOOL_T;
+    }
 }
 #undef FUNC_NAME
 
-GUILE_PROC1 (scm_string_ci_equal_p, "string-ci=?", scm_tc7_rpsubr,
+
+SCM_DEFINE1 (scm_string_ci_equal_p, "string-ci=?", scm_tc7_rpsubr,
              (SCM s1, SCM s2),
-"")
+            "Case-insensitive string equality predicate; returns @t{#t} if\n"
+            "the two strings are the same length and their component characters\n"
+            "match (ignoring case) at each position; otherwise returns @t{#f}. (r5rs)")
 #define FUNC_NAME s_scm_string_ci_equal_p
 {
-  register scm_sizet i;
-  register unsigned char *c1, *c2;
-  SCM_VALIDATE_ROSTRING (1,s1);
-  SCM_VALIDATE_ROSTRING (2,s2);
+  scm_sizet length;
+
+  SCM_VALIDATE_STRING (1, s1);
+  SCM_VALIDATE_STRING (2, s2);
 
-  i = SCM_ROLENGTH (s2);
-  if (SCM_ROLENGTH (s1) != i)
+  length = SCM_STRING_LENGTH (s2);
+  if (SCM_STRING_LENGTH (s1) == length)
     {
-      return SCM_BOOL_F;
+      unsigned char *c1 = SCM_STRING_UCHARS (s1) + length - 1;
+      unsigned char *c2 = SCM_STRING_UCHARS (s2) + length - 1;
+      scm_sizet i;
+
+      /* comparing from back to front typically finds mismatches faster */
+      for (i = 0; i != length; ++i, --c1, --c2)
+       if (scm_upcase (*c1) != scm_upcase (*c2))
+         return SCM_BOOL_F;
+
+      return SCM_BOOL_T;
     }
-  c1 = SCM_ROUCHARS (s1);
-  c2 = SCM_ROUCHARS (s2);
-  while (0 != i--)
-    if (scm_upcase(*c1++) != scm_upcase(*c2++))
+  else
+    {
       return SCM_BOOL_F;
-  return SCM_BOOL_T;
+    }
 }
 #undef FUNC_NAME
 
-GUILE_PROC1 (scm_string_less_p, "string<?", scm_tc7_rpsubr,
+
+/* Helper function for the lexicographic ordering predicates.
+ * No argument checking is performed.  */
+static SCM
+string_less_p (SCM s1, SCM s2)
+{
+  scm_sizet i, length1, length2, lengthm;
+  unsigned char *c1, *c2;
+
+  length1 = SCM_STRING_LENGTH (s1);
+  length2 = SCM_STRING_LENGTH (s2);
+  lengthm = min (length1, length2);
+  c1 = SCM_STRING_UCHARS (s1);
+  c2 = SCM_STRING_UCHARS (s2);
+
+  for (i = 0; i != lengthm; ++i, ++c1, ++c2) {
+    int c = *c1 - *c2;
+    if (c < 0) return SCM_BOOL_T;
+    if (c > 0) return SCM_BOOL_F;
+  }
+
+  return SCM_BOOL (length1 < length2);
+}
+
+
+SCM_DEFINE1 (scm_string_less_p, "string<?", scm_tc7_rpsubr,
              (SCM s1, SCM s2),
-"")
+            "Lexicographic ordering predicate; returns @t{#t} if @var{s1}\n"
+            "is lexicographically less than @var{s2}.  (r5rs)")
 #define FUNC_NAME s_scm_string_less_p
 {
-  register scm_sizet i, len, s2len;
-  register unsigned char *c1, *c2;
-  register int c;
-
-  SCM_VALIDATE_ROSTRING (1,s1);
-  SCM_VALIDATE_ROSTRING (2,s2);
-  len = SCM_ROLENGTH (s1);
-  s2len = SCM_ROLENGTH (s2);
-  if (len>s2len) len = s2len;
-  c1 = SCM_ROUCHARS (s1);
-  c2 = SCM_ROUCHARS (s2);
-
-  for (i = 0;i<len;i++) {
-    c = (*c1++ - *c2++);
-    if (c>0)
-      return SCM_BOOL_F;
-    if (c<0)
-      return SCM_BOOL_T;
-  }
-  {
-    SCM answer;
-    answer = SCM_BOOL(s2len != len);
-    return answer;
-  }
+  SCM_VALIDATE_STRING (1, s1);
+  SCM_VALIDATE_STRING (2, s2);
+
+  return string_less_p (s1, s2);
 }
 #undef FUNC_NAME
 
-GUILE_PROC1 (scm_string_leq_p, "string<=?", scm_tc7_rpsubr,
+
+SCM_DEFINE1 (scm_string_leq_p, "string<=?", scm_tc7_rpsubr,
              (SCM s1, SCM s2),
-"")
+            "Lexicographic ordering predicate; returns @t{#t} if @var{s1}\n"
+            "is lexicographically less than or equal to @var{s2}.  (r5rs)")
 #define FUNC_NAME s_scm_string_leq_p
 {
-  return SCM_BOOL_NOT (scm_string_less_p (s2, s1));
+  SCM_VALIDATE_STRING (1, s1);
+  SCM_VALIDATE_STRING (2, s2);
+
+  return SCM_BOOL_NOT (string_less_p (s2, s1));
 }
 #undef FUNC_NAME
 
-GUILE_PROC1 (scm_string_gr_p, "string>?", scm_tc7_rpsubr,
+
+SCM_DEFINE1 (scm_string_gr_p, "string>?", scm_tc7_rpsubr,
              (SCM s1, SCM s2),
-"")
+            "Lexicographic ordering predicate; returns @t{#t} if @var{s1}\n"
+            "is lexicographically greater than @var{s2}.  (r5rs)")
 #define FUNC_NAME s_scm_string_gr_p
 {
-  return scm_string_less_p (s2, s1);
+  SCM_VALIDATE_STRING (1, s1);
+  SCM_VALIDATE_STRING (2, s2);
+
+  return string_less_p (s2, s1);
 }
 #undef FUNC_NAME
 
-GUILE_PROC1 (scm_string_geq_p, "string>=?", scm_tc7_rpsubr,
+
+SCM_DEFINE1 (scm_string_geq_p, "string>=?", scm_tc7_rpsubr,
              (SCM s1, SCM s2),
-"")
+            "Lexicographic ordering predicate; returns @t{#t} if @var{s1}\n"
+            "is lexicographically greater than or equal to @var{s2}.  (r5rs)")
 #define FUNC_NAME s_scm_string_geq_p
 {
-  return SCM_BOOL_NOT (scm_string_less_p (s1, s2));
+  SCM_VALIDATE_STRING (1, s1);
+  SCM_VALIDATE_STRING (2, s2);
+
+  return SCM_BOOL_NOT (string_less_p (s1, s2));
 }
 #undef FUNC_NAME
 
-GUILE_PROC1 (scm_string_ci_less_p, "string-ci<?", scm_tc7_rpsubr,
+
+/* Helper function for the case insensitive lexicographic ordering
+ * predicates.  No argument checking is performed.  */
+static SCM
+string_ci_less_p (SCM s1, SCM s2)
+{
+  scm_sizet i, length1, length2, lengthm;
+  unsigned char *c1, *c2;
+
+  length1 = SCM_STRING_LENGTH (s1);
+  length2 = SCM_STRING_LENGTH (s2);
+  lengthm = min (length1, length2);
+  c1 = SCM_STRING_UCHARS (s1);
+  c2 = SCM_STRING_UCHARS (s2);
+
+  for (i = 0; i != lengthm; ++i, ++c1, ++c2) {
+    int c = scm_upcase (*c1) - scm_upcase (*c2);
+    if (c < 0) return SCM_BOOL_T;
+    if (c > 0) return SCM_BOOL_F;
+  }
+
+  return SCM_BOOL (length1 < length2);
+}
+
+
+SCM_DEFINE1 (scm_string_ci_less_p, "string-ci<?", scm_tc7_rpsubr,
              (SCM s1, SCM s2),
-"")
+            "Case insensitive lexicographic ordering predicate; \n"
+            "returns @t{#t} if @var{s1} is lexicographically less than\n"
+            "@var{s2} regardless of case.  (r5rs)")
 #define FUNC_NAME s_scm_string_ci_less_p
 {
-  register scm_sizet i, len, s2len;
-  register unsigned char *c1, *c2;
-  register int c;
-  SCM_VALIDATE_ROSTRING (1,s1);
-  SCM_VALIDATE_ROSTRING (2,s2);
-  len = SCM_ROLENGTH (s1);
-  s2len = SCM_ROLENGTH (s2);
-  if (len>s2len) len = s2len;
-  c1 = SCM_ROUCHARS (s1);
-  c2 = SCM_ROUCHARS (s2);
-  for (i = 0;i<len;i++) {
-    c = (scm_upcase(*c1++) - scm_upcase(*c2++));
-    if (c>0) return SCM_BOOL_F;
-    if (c<0) return SCM_BOOL_T;
-  }
-  return SCM_BOOL(s2len != len);
+  SCM_VALIDATE_STRING (1, s1);
+  SCM_VALIDATE_STRING (2, s2);
+
+  return string_ci_less_p (s1, s2);
 }
 #undef FUNC_NAME
 
-GUILE_PROC1 (scm_string_ci_leq_p, "string-ci<=?", scm_tc7_rpsubr,
+
+SCM_DEFINE1 (scm_string_ci_leq_p, "string-ci<=?", scm_tc7_rpsubr,
              (SCM s1, SCM s2),
-"")
+            "Case insensitive lexicographic ordering predicate; \n"
+            "returns @t{#t} if @var{s1} is lexicographically less than\n"
+            "or equal to @var{s2} regardless of case.  (r5rs)")
 #define FUNC_NAME s_scm_string_ci_leq_p
 {
-  return SCM_BOOL_NOT (scm_string_ci_less_p (s2, s1));
+  SCM_VALIDATE_STRING (1, s1);
+  SCM_VALIDATE_STRING (2, s2);
+
+  return SCM_BOOL_NOT (string_ci_less_p (s2, s1));
 }
 #undef FUNC_NAME
 
-GUILE_PROC1 (scm_string_ci_gr_p, "string-ci>?", scm_tc7_rpsubr,
+
+SCM_DEFINE1 (scm_string_ci_gr_p, "string-ci>?", scm_tc7_rpsubr,
              (SCM s1, SCM s2),
-"")
+            "Case insensitive lexicographic ordering predicate; \n"
+            "returns @t{#t} if @var{s1} is lexicographically greater than\n"
+            "@var{s2} regardless of case.  (r5rs)")
 #define FUNC_NAME s_scm_string_ci_gr_p
 {
-  return scm_string_ci_less_p (s2, s1);
+  SCM_VALIDATE_STRING (1, s1);
+  SCM_VALIDATE_STRING (2, s2);
+
+  return string_ci_less_p (s2, s1);
 }
 #undef FUNC_NAME
 
-GUILE_PROC1 (scm_string_ci_geq_p, "string-ci>=?", scm_tc7_rpsubr,
+
+SCM_DEFINE1 (scm_string_ci_geq_p, "string-ci>=?", scm_tc7_rpsubr,
              (SCM s1, SCM s2),
-"")
+            "Case insensitive lexicographic ordering predicate; \n"
+            "returns @t{#t} if @var{s1} is lexicographically greater than\n"
+            "or equal to @var{s2} regardless of case.  (r5rs)")
 #define FUNC_NAME s_scm_string_ci_geq_p
 {
-  return SCM_BOOL_NOT (scm_string_ci_less_p (s1, s2));
+  SCM_VALIDATE_STRING (1, s1);
+  SCM_VALIDATE_STRING (2, s2);
+
+  return SCM_BOOL_NOT (string_ci_less_p (s1, s2));
 }
 #undef FUNC_NAME
 
@@ -214,6 +292,14 @@ GUILE_PROC1 (scm_string_ci_geq_p, "string-ci>=?", scm_tc7_rpsubr,
 void
 scm_init_strorder ()
 {
-#include "strorder.x"
+#ifndef SCM_MAGIC_SNARFER
+#include "libguile/strorder.x"
+#endif
 }
 
+
+/*
+  Local Variables:
+  c-file-style: "gnu"
+  End:
+*/