libcfs/include/libcfs/libcfs_string.h

   1 /* -*- mode: c; c-basic-offset: 8; indent-tabs-mode: nil; -*-
   2  * vim:expandtab:shiftwidth=8:tabstop=8:
   3  *
   4  * GPL HEADER START
   5  *
   6  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   7  *
   8  * This program is free software; you can redistribute it and/or modify
   9  * it under the terms of the GNU General Public License version 2 only,
  10  * as published by the Free Software Foundation.
  11  *
  12  * This program is distributed in the hope that it will be useful, but
  13  * WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  15  * General Public License version 2 for more details (a copy is included
  16  * in the LICENSE file that accompanied this code).
  17  *
  18  * You should have received a copy of the GNU General Public License
  19  * version 2 along with this program; If not, see
  20  * http://www.sun.com/software/products/lustre/docs/GPLv2.pdf
  21  *
  22  * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
  23  * CA 95054 USA or visit www.sun.com if you need additional information or
  24  * have any questions.
  25  *
  26  * GPL HEADER END
  27  */
  28 /*
  29  * Copyright (c) 2008, 2010, Oracle and/or its affiliates. All rights reserved.
  30  * Use is subject to license terms.
  31  *
  32  * Copyright (c) 2012, Whamcloud, Inc.
  33  */
  34 /*
  35  * This file is part of Lustre, http://www.lustre.org/
  36  * Lustre is a trademark of Sun Microsystems, Inc.
  37  *
  38  * libcfs/include/libcfs/libcfs_string.h
  39  *
  40  * Generic string manipulation functions.
  41  *
  42  * Author: Nathan Rutman <nathan.rutman@sun.com>
  43  */
  44
  45 #ifndef __LIBCFS_STRING_H__
  46 #define __LIBCFS_STRING_H__
  47
  48 /* libcfs_string.c */
  49 /* Convert a text string to a bitmask */
  50 int cfs_str2mask(const char *str, const char *(*bit2str)(int bit),
  51                  int *oldmask, int minmask, int allmask);
  52
  53 /* Allocate space for and copy an existing string.
  54  * Must free with cfs_free().
  55  */
  56 char *cfs_strdup(const char *str, u_int32_t flags);
  57
  58 /* safe vsnprintf */
  59 int cfs_vsnprintf(char *buf, size_t size, const char *fmt, va_list args);
  60
  61 /* safe snprintf */
  62 int cfs_snprintf(char *buf, size_t size, const char *fmt, ...);
  63
  64 /* trim leading and trailing space characters */
  65 char *cfs_firststr(char *str, size_t size);
  66 #endif