common/str.h

Go to the documentation of this file.

//
//      aegis - project change supervisor
//      Copyright (C) 1991-1995, 1998, 1999, 2001-2006, 2008 Peter Miller
//
//      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
//      the Free Software Foundation; either version 3 of the License, or
//      (at your option) any later version.
//
//      This program is distributed in the hope that it will be useful,
//      but WITHOUT ANY WARRANTY; without even the implied warranty of
//      MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
//      GNU General Public License for more details.
//
//      You should have received a copy of the GNU General Public License
//      along with this program. If not, see
//      <http://www.gnu.org/licenses/>.
//

#ifndef STR_H
#define STR_H

#include <common/ac/stddef.h>
#include <common/ac/stdarg.h>
#include <common/main.h>

typedef unsigned long str_hash_ty;

struct string_ty
{
    str_hash_ty     str_hash;

    string_ty       *str_next;

    long            str_references;

    size_t          str_length;

    char            str_text[1];
};

void str_release(void);

string_ty *str_from_c(const char *str);

string_ty *str_n_from_c(const char *str, size_t len);

string_ty *str_copy(string_ty *str);

void str_free(string_ty *str);

string_ty *str_catenate(string_ty *str1, string_ty *str2);

string_ty *str_cat_three(string_ty *str1, string_ty *str2, string_ty *str3);

int str_bool(string_ty *str);

string_ty *str_upcase(string_ty *str);

string_ty *str_downcase(string_ty *str);

string_ty *str_capitalize(string_ty *str);

void str_dump(void);

string_ty *str_field(string_ty *str, int sep, int nth);

void slow_to_fast(const char *const *, string_ty **, size_t);

string_ty *str_format(const char *fmt, ...)               ATTR_PRINTF(1, 2);

string_ty *str_vformat(const char *fmt, va_list ap);

int str_equal(string_ty *str1, string_ty *str2);

#define str_equal(s1, s2) ((s1) == (s2))

string_ty *str_quote_shell(string_ty *str);

string_ty *str_trim(string_ty *str);

string_ty *str_snip(string_ty *str);

int str_validate(const string_ty *str);

int str_leading_prefix(string_ty *haystack, string_ty *needle);

int str_trailing_suffix(string_ty *haystack, string_ty *needle);

string_ty *str_identifier(string_ty *str);

string_ty *str_replace(string_ty *str, string_ty *lhs, string_ty *rhs,
    int maximum = -1);

#endif // STR_H

---