cddl/contrib/opensolaris/cmd/sgs/include/string_table.h

   1 /*
   2  * CDDL HEADER START
   3  *
   4  * The contents of this file are subject to the terms of the
   5  * Common Development and Distribution License (the "License").
   6  * You may not use this file except in compliance with the License.
   7  *
   8  * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
   9  * or http://www.opensolaris.org/os/licensing.
  10  * See the License for the specific language governing permissions
  11  * and limitations under the License.
  12  *
  13  * When distributing Covered Code, include this CDDL HEADER in each
  14  * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
  15  * If applicable, add the following below this CDDL HEADER, with the
  16  * fields enclosed by brackets "[]" replaced with your own identifying
  17  * information: Portions Copyright [yyyy] [name of copyright owner]
  18  *
  19  * CDDL HEADER END
  20  */
  21 /*
  22  * Copyright 2008 Sun Microsystems, Inc.  All rights reserved.
  23  * Use is subject to license terms.
  24  */
  25
  26 #ifndef _STRING_TABLE_DOT_H
  27 #define _STRING_TABLE_DOT_H
  28
  29 #pragma ident   "%Z%%M% %I%     %E% SMI"
  30
  31 #include <sys/types.h>
  32
  33 #ifdef __cplusplus
  34 extern "C" {
  35 #endif
  36
  37 /*
  38  * Exported, opaque string table handle.
  39  */
  40 typedef struct str_tbl  Str_tbl;
  41
  42 /*
  43  * Exported string table functions.
  44  */
  45 extern int              st_delstring(Str_tbl *, const char *);
  46 extern void             st_destroy(Str_tbl *);
  47 extern size_t           st_getstrtab_sz(Str_tbl *);
  48 extern const char       *st_getstrbuf(Str_tbl *);
  49 extern int              st_insert(Str_tbl *, const char *);
  50 extern Str_tbl          *st_new(uint_t);
  51 extern int              st_setstrbuf(Str_tbl *, char *, size_t);
  52 extern int              st_setstring(Str_tbl *, const char *, size_t *);
  53
  54 /*
  55  * Exported flags values for st_new().
  56  */
  57 #define FLG_STNEW_COMPRESS      0x01    /* compressed string table */
  58
  59 #ifdef __cplusplus
  60 }
  61 #endif
  62
  63 #endif /* _STRING_TABLE_DOT_H */