* coop.c (coop_finish): New function. Called at exit.
[bpt/guile.git] / libguile / strorder.c
index ee2cb22..edaff6d 100644 (file)
  * If you write modifications of your own for GUILE, it is your choice
  * 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 "_scm.h"
 #include "chars.h"
 
+#include "validate.h"
 #include "strorder.h"
 \f
 
-SCM_PROC1 (s_string_equal_p, "string=?", scm_tc7_rpsubr, scm_string_equal_p);
-
-SCM
-scm_string_equal_p (s1, s2)
-     SCM s1;
-     SCM s2;
+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_ASSERT (SCM_NIMP (s1) && SCM_ROSTRINGP (s1), s1, SCM_ARG1, s_string_equal_p);
-  SCM_ASSERT (SCM_NIMP (s2) && SCM_ROSTRINGP (s2), s2, SCM_ARG2, s_string_equal_p);
+  SCM_VALIDATE_ROSTRING (1,s1);
+  SCM_VALIDATE_ROSTRING (2,s2);
 
   i = SCM_ROLENGTH (s2);
   if (SCM_ROLENGTH (s1) != i)
@@ -71,18 +78,20 @@ scm_string_equal_p (s1, s2)
       return SCM_BOOL_F;
   return SCM_BOOL_T;
 }
-
-SCM_PROC1 (s_string_ci_equal_p, "string-ci=?", scm_tc7_rpsubr, scm_string_ci_equal_p);
-
-SCM
-scm_string_ci_equal_p (s1, s2)
-     SCM s1;
-     SCM s2;
+#undef FUNC_NAME
+
+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_ASSERT (SCM_NIMP (s1) && SCM_ROSTRINGP (s1), s1, SCM_ARG1, s_string_ci_equal_p);
-  SCM_ASSERT (SCM_NIMP (s2) && SCM_ROSTRINGP (s2), s2, SCM_ARG2, s_string_ci_equal_p);
+  SCM_VALIDATE_ROSTRING (1,s1);
+  SCM_VALIDATE_ROSTRING (2,s2);
+
   i = SCM_ROLENGTH (s2);
   if (SCM_ROLENGTH (s1) != i)
     {
@@ -95,20 +104,20 @@ scm_string_ci_equal_p (s1, s2)
       return SCM_BOOL_F;
   return SCM_BOOL_T;
 }
+#undef FUNC_NAME
 
-SCM_PROC1 (s_string_less_p, "string<?", scm_tc7_rpsubr, scm_string_less_p);
-
-SCM
-scm_string_less_p (s1, s2)
-     SCM s1;
-     SCM s2;
+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_ASSERT (SCM_NIMP (s1) && SCM_ROSTRINGP (s1), s1, SCM_ARG1, s_string_less_p);
-  SCM_ASSERT (SCM_NIMP (s2) && SCM_ROSTRINGP (s2), s2, SCM_ARG2, s_string_less_p);
+  SCM_VALIDATE_ROSTRING (1,s1);
+  SCM_VALIDATE_ROSTRING (2,s2);
   len = SCM_ROLENGTH (s1);
   s2len = SCM_ROLENGTH (s2);
   if (len>s2len) len = s2len;
@@ -128,49 +137,50 @@ scm_string_less_p (s1, s2)
     return answer;
   }
 }
+#undef FUNC_NAME
 
-SCM_PROC1 (s_string_leq_p, "string<=?", scm_tc7_rpsubr, scm_string_leq_p);
-
-SCM
-scm_string_leq_p (s1, s2)
-     SCM s1;
-     SCM s2;
+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));
 }
+#undef FUNC_NAME
 
-SCM_PROC1 (s_string_gr_p, "string>?", scm_tc7_rpsubr, scm_string_gr_p);
-
-SCM
-scm_string_gr_p (s1, s2)
-     SCM s1;
-     SCM s2;
+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);
 }
+#undef FUNC_NAME
 
-SCM_PROC1 (s_string_geq_p, "string>=?", scm_tc7_rpsubr, scm_string_geq_p);
-
-SCM
-scm_string_geq_p (s1, s2)
-     SCM s1;
-     SCM s2;
+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_PROC1 (s_string_ci_less_p, "string-ci<?", scm_tc7_rpsubr, scm_string_ci_less_p);
-
-SCM
-scm_string_ci_less_p (s1, s2)
-     SCM s1;
-     SCM 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
 {
   register scm_sizet i, len, s2len;
   register unsigned char *c1, *c2;
   register int c;
-  SCM_ASSERT (SCM_NIMP (s1) && SCM_ROSTRINGP (s1), s1, SCM_ARG1, s_string_ci_less_p);
-  SCM_ASSERT (SCM_NIMP (s2) && SCM_ROSTRINGP (s2), s2, SCM_ARG2, s_string_ci_less_p);
+  SCM_VALIDATE_ROSTRING (1,s1);
+  SCM_VALIDATE_ROSTRING (2,s2);
   len = SCM_ROLENGTH (s1);
   s2len = SCM_ROLENGTH (s2);
   if (len>s2len) len = s2len;
@@ -183,36 +193,40 @@ scm_string_ci_less_p (s1, s2)
   }
   return SCM_BOOL(s2len != len);
 }
-
-SCM_PROC1 (s_string_ci_leq_p, "string-ci<=?", scm_tc7_rpsubr, scm_string_ci_leq_p);
-
-SCM
-scm_string_ci_leq_p (s1, s2)
-     SCM s1;
-     SCM 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)")
+#define FUNC_NAME s_scm_string_ci_leq_p
 {
   return SCM_BOOL_NOT (scm_string_ci_less_p (s2, s1));
 }
-
-SCM_PROC1 (s_string_ci_gr_p, "string-ci>?", scm_tc7_rpsubr, scm_string_ci_gr_p);
-
-SCM
-scm_string_ci_gr_p (s1, s2)
-     SCM s1;
-     SCM s2;
+#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)")
+#define FUNC_NAME s_scm_string_ci_gr_p
 {
   return scm_string_ci_less_p (s2, s1);
 }
-
-SCM_PROC1 (s_string_ci_geq_p, "string-ci>=?", scm_tc7_rpsubr, scm_string_ci_geq_p);
-
-SCM
-scm_string_ci_geq_p (s1, s2)
-     SCM s1;
-     SCM s2;
+#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)")
+#define FUNC_NAME s_scm_string_ci_geq_p
 {
   return SCM_BOOL_NOT (scm_string_ci_less_p (s1, s2));
 }
+#undef FUNC_NAME
 
 \f
 
@@ -222,3 +236,9 @@ scm_init_strorder ()
 #include "strorder.x"
 }
 
+
+/*
+  Local Variables:
+  c-file-style: "gnu"
+  End:
+*/