str: New function ds_put_substring_multiple().

[pspp] / src / libpspp / str.h

diff --git a/src/libpspp/str.h b/src/libpspp/str.h
index 306bd8ba89f110762dbf31f04abace081227b0cc..91de05f395264f2d3231ef9d23c82eda9788602f 100644 (file)
--- a/src/libpspp/str.h
+++ b/src/libpspp/str.h
@@ -1,5 +1,5 @@
 /* PSPP - a program for statistical analysis.
-   Copyright (C) 1997-9, 2000, 2009, 2010, 2011, 2012 Free Software Foundation, Inc.
+   Copyright (C) 1997-9, 2000, 2009, 2010, 2011, 2012, 2014 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
@@ -29,9 +29,13 @@
 #include "memcasecmp.h"
 #include "xstrndup.h"
 #include "xvasprintf.h"
+
+#include "gl/xalloc.h"
 \f
 /* Miscellaneous. */
 
+struct substring;
+
 void buf_reverse (char *, size_t);
 int buf_compare_case (const char *, const char *, size_t);
 int buf_compare_rpad (const char *, size_t, const char *, size_t);
@@ -47,7 +51,12 @@ void str_copy_buf_trunc (char *, size_t, const char *, size_t);
 void str_uppercase (char *);
 void str_lowercase (char *);
 
-bool str_format_26adic (unsigned long int number, char buffer[], size_t);
+bool str_format_26adic (unsigned long int number, bool uppercase,
+                        char buffer[], size_t);
+
+void str_ellipsize (struct substring in, char *out, size_t out_size);
+
+static inline char *xstrdup_if_nonnull (const char *);
 
 void *mempset (void *, int, size_t);
 \f
@@ -94,6 +103,7 @@ void ss_dealloc (struct substring *);
 /* Mutators.
    Functions that advance the beginning of a string should not be
    used if a substring is to be deallocated. */
+void ss_swap (struct substring *, struct substring *);
 void ss_truncate (struct substring *, size_t);
 size_t ss_rtrim (struct substring *, struct substring trim_set);
 size_t ss_ltrim (struct substring *, struct substring trim_set);
@@ -109,7 +119,7 @@ bool ss_match_byte (struct substring *, char);
 int ss_match_byte_in (struct substring *, struct substring);
 bool ss_match_string (struct substring *, const struct substring);
 int ss_get_byte (struct substring *);
-size_t ss_get_bytes (struct substring *, size_t cnt, struct substring *);
+size_t ss_get_bytes (struct substring *, size_t n, struct substring *);
 bool ss_get_until (struct substring *, char delimiter, struct substring *);
 size_t ss_get_long (struct substring *, long *);
 
@@ -121,10 +131,12 @@ char *ss_end (struct substring);
 int ss_at (struct substring, size_t idx);
 int ss_first (struct substring);
 int ss_last (struct substring);
+bool ss_starts_with (struct substring, struct substring prefix);
 bool ss_ends_with (struct substring, struct substring suffix);
 size_t ss_span (struct substring, struct substring skip_set);
 size_t ss_cspan (struct substring, struct substring stop_set);
 size_t ss_find_byte (struct substring, char);
+size_t ss_find_substring (struct substring, struct substring);
 int ss_compare (struct substring, struct substring);
 int ss_compare_case (struct substring, struct substring);
 int ss_equals (struct substring, struct substring);
@@ -138,6 +150,8 @@ int ss_first_mblen (struct substring);
 ucs4_t ss_get_mb (struct substring *);
 ucs4_t ss_at_mb (struct substring, size_t ofs);
 int ss_at_mblen (struct substring, size_t ofs);
+size_t ss_utf8_count_columns (struct substring);
+struct substring ss_utf8_columns (struct substring, size_t start, size_t n);
 \f
 /* Variable length strings. */
 
@@ -218,7 +232,7 @@ char *ds_steal_cstr (struct string *);
 /* File input. */
 bool ds_read_line (struct string *, FILE *, size_t max_length);
 bool ds_read_config_line (struct string *, int *line_number, FILE *);
-bool ds_read_stream (struct string *, size_t size, size_t cnt, FILE *stream);
+bool ds_read_stream (struct string *, size_t size, size_t n, FILE *stream);
 
 /* Append. */
 void ds_put_byte (struct string *, int ch);
@@ -226,6 +240,7 @@ void ds_put_byte_multiple (struct string *, int ch, size_t);
 void ds_put_unichar (struct string *, ucs4_t uc);
 void ds_put_cstr (struct string *, const char *);
 void ds_put_substring (struct string *, struct substring);
+void ds_put_substring_multiple (struct string *, struct substring, size_t n);
 void ds_put_vformat (struct string *st, const char *, va_list)
      PRINTF_FORMAT (2, 0);
 void ds_put_c_vformat (struct string *st, const char *, va_list)
@@ -267,15 +282,21 @@ ss_cstr (const char *cstr)
   return ss_buffer (cstr, strlen (cstr));
 }
 
-/* Returns a substring whose contents are the CNT characters in
+/* Returns a substring whose contents are the N characters in
    BUFFER. */
 static inline struct substring
-ss_buffer (const char *buffer, size_t cnt)
+ss_buffer (const char *buffer, size_t n)
 {
   struct substring ss;
   ss.string = (char *) buffer;
-  ss.length = cnt;
+  ss.length = n;
   return ss;
 }
 
+static inline char *
+xstrdup_if_nonnull (const char *s)
+{
+  return s ? xstrdup (s) : NULL;
+}
+
 #endif /* str_h */