* threads.scm (letpar): New macro.
[bpt/guile.git] / libguile / strorder.c
index 815488a..faebcf0 100644 (file)
  * whether to permit this exception to apply to your modifications.
  * If you do not wish that, delete this exception notice.  */
 
-/* Software engineering face-lift by Greg J. Badros, 11-Dec-1999,
-   gjb@cs.washington.edu, http://www.cs.washington.edu/homes/gjb */
 \f
 
-#include <stdio.h>
 #include "libguile/_scm.h"
 #include "libguile/chars.h"
 #include "libguile/strings.h"
 
 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.")
+           "Lexicographic equality predicate; return @code{#t} if the two\n"
+           "strings are the same length and contain the same characters in\n"
+           "the same positions, otherwise return @code{#f}.\n"
+           "\n"
+           "The procedure @code{string-ci=?} treats upper and lower case\n"
+           "letters as though they were the same character, but\n"
+           "@code{string=?} treats upper and lower case as distinct\n"
+           "characters.")
 #define FUNC_NAME s_scm_string_equal_p
 {
-  scm_sizet length;
+  size_t length;
 
   SCM_VALIDATE_STRING (1, s1);
   SCM_VALIDATE_STRING (2, s2);
@@ -73,7 +72,7 @@ SCM_DEFINE1 (scm_string_equal_p, "string=?", scm_tc7_rpsubr,
     {
       unsigned char *c1 = SCM_STRING_UCHARS (s1) + length - 1;
       unsigned char *c2 = SCM_STRING_UCHARS (s2) + length - 1;
-      scm_sizet i;
+      size_t i;
 
       /* comparing from back to front typically finds mismatches faster */
       for (i = 0; i != length; ++i, --c1, --c2)
@@ -92,12 +91,13 @@ SCM_DEFINE1 (scm_string_equal_p, "string=?", 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)")
+           "Case-insensitive string equality predicate; return @code{#t} if\n"
+           "the two strings are the same length and their component\n"
+           "characters match (ignoring case) at each position; otherwise\n"
+           "return @code{#f}.")
 #define FUNC_NAME s_scm_string_ci_equal_p
 {
-  scm_sizet length;
+  size_t length;
 
   SCM_VALIDATE_STRING (1, s1);
   SCM_VALIDATE_STRING (2, s2);
@@ -107,7 +107,7 @@ SCM_DEFINE1 (scm_string_ci_equal_p, "string-ci=?", scm_tc7_rpsubr,
     {
       unsigned char *c1 = SCM_STRING_UCHARS (s1) + length - 1;
       unsigned char *c2 = SCM_STRING_UCHARS (s2) + length - 1;
-      scm_sizet i;
+      size_t i;
 
       /* comparing from back to front typically finds mismatches faster */
       for (i = 0; i != length; ++i, --c1, --c2)
@@ -124,18 +124,14 @@ SCM_DEFINE1 (scm_string_ci_equal_p, "string-ci=?", scm_tc7_rpsubr,
 #undef FUNC_NAME
 
 
-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
+/* 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;
+  size_t i, length1, length2, lengthm;
   unsigned char *c1, *c2;
 
-  SCM_VALIDATE_STRING (1, s1);
-  SCM_VALIDATE_STRING (2, s2);
-
   length1 = SCM_STRING_LENGTH (s1);
   length2 = SCM_STRING_LENGTH (s2);
   lengthm = min (length1, length2);
@@ -150,55 +146,72 @@ SCM_DEFINE1 (scm_string_less_p, "string<?", scm_tc7_rpsubr,
 
   return SCM_BOOL (length1 < length2);
 }
+
+
+SCM_DEFINE1 (scm_string_less_p, "string<?", scm_tc7_rpsubr,
+             (SCM s1, SCM s2),
+           "Lexicographic ordering predicate; return @code{#t} if @var{s1}\n"
+           "is lexicographically less than @var{s2}.")
+#define FUNC_NAME s_scm_string_less_p
+{
+  SCM_VALIDATE_STRING (1, s1);
+  SCM_VALIDATE_STRING (2, s2);
+
+  return string_less_p (s1, s2);
+}
 #undef FUNC_NAME
 
 
 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)")
+           "Lexicographic ordering predicate; return @code{#t} if @var{s1}\n"
+           "is lexicographically less than or equal to @var{s2}.")
 #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
 
 
 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)")
+           "Lexicographic ordering predicate; return @code{#t} if @var{s1}\n"
+           "is lexicographically greater than @var{s2}.")
 #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
 
 
 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)")
+           "Lexicographic ordering predicate; return @code{#t} if @var{s1}\n"
+           "is lexicographically greater than or equal to @var{s2}.")
 #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
 
 
-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
+/* 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;
+  size_t i, length1, length2, lengthm;
   unsigned char *c1, *c2;
 
-  SCM_VALIDATE_STRING (1, s1);
-  SCM_VALIDATE_STRING (2, s2);
-
   length1 = SCM_STRING_LENGTH (s1);
   length2 = SCM_STRING_LENGTH (s2);
   lengthm = min (length1, length2);
@@ -213,41 +226,64 @@ SCM_DEFINE1 (scm_string_ci_less_p, "string-ci<?", scm_tc7_rpsubr,
 
   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; return\n"
+           "@code{#t} if @var{s1} is lexicographically less than @var{s2}\n"
+           "regardless of case.")
+#define FUNC_NAME s_scm_string_ci_less_p
+{
+  SCM_VALIDATE_STRING (1, s1);
+  SCM_VALIDATE_STRING (2, s2);
+
+  return string_ci_less_p (s1, s2);
+}
 #undef FUNC_NAME
 
 
 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)")
+           "Case insensitive lexicographic ordering predicate; return\n"
+           "@code{#t} if @var{s1} is lexicographically less than or equal\n"
+           "to @var{s2} regardless of case.")
 #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
 
 
 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)")
+           "Case insensitive lexicographic ordering predicate; return\n"
+           "@code{#t} if @var{s1} is lexicographically greater than\n"
+           "@var{s2} regardless of case.")
 #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
 
 
 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)")
+           "Case insensitive lexicographic ordering predicate; return\n"
+           "@code{#t} if @var{s1} is lexicographically greater than or\n"
+           "equal to @var{s2} regardless of case.")
 #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
 
@@ -256,9 +292,7 @@ SCM_DEFINE1 (scm_string_ci_geq_p, "string-ci>=?", scm_tc7_rpsubr,
 void
 scm_init_strorder ()
 {
-#ifndef SCM_MAGIC_SNARFER
 #include "libguile/strorder.x"
-#endif
 }