include/strlist.h

   1 /* ----------------------------------------------------------------------- *
   2  *
   3  *   Copyright 1996-2018 The NASM Authors - All Rights Reserved
   4  *   See the file AUTHORS included with the NASM distribution for
   5  *   the specific copyright holders.
   6  *
   7  *   Redistribution and use in source and binary forms, with or without
   8  *   modification, are permitted provided that the following
   9  *   conditions are met:
  10  *
  11  *   * Redistributions of source code must retain the above copyright
  12  *     notice, this list of conditions and the following disclaimer.
  13  *   * Redistributions in binary form must reproduce the above
  14  *     copyright notice, this list of conditions and the following
  15  *     disclaimer in the documentation and/or other materials provided
  16  *     with the distribution.
  17  *
  18  *     THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
  19  *     CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
  20  *     INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
  21  *     MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
  22  *     DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
  23  *     CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  24  *     SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  25  *     NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  26  *     LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  27  *     HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  28  *     CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
  29  *     OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
  30  *     EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  31  *
  32  * ----------------------------------------------------------------------- */
  33
  34 /*
  35  * strlist.h - list of unique, ordered strings
  36  */
  37
  38 #ifndef NASM_STRLIST_H
  39 #define NASM_STRLIST_H
  40
  41 #include "compiler.h"
  42 #include "nasmlib.h"
  43 #include "hashtbl.h"
  44
  45 struct strlist_entry {
  46         struct strlist_entry    *next;
  47         size_t                  offset;
  48         size_t                  size;
  49         intorptr                pvt;
  50         char                    str[1];
  51 };
  52
  53 struct strlist {
  54         struct hash_table       hash;
  55         struct strlist_entry    *head, **tailp;
  56         size_t                  nstr, size;
  57         bool                    uniq;
  58 };
  59
  60 static inline const struct strlist_entry *
  61 strlist_head(const struct strlist *list)
  62 {
  63         return list ? list->head : NULL;
  64 }
  65 static inline struct strlist_entry *strlist_tail(struct strlist *list)
  66 {
  67         if (!list || !list->head)
  68                 return NULL;
  69         return container_of(list->tailp, struct strlist_entry, next);
  70 }
  71 static inline size_t strlist_count(const struct strlist *list)
  72 {
  73         return list ? list->nstr : 0;
  74 }
  75 static inline size_t strlist_size(const struct strlist *list)
  76 {
  77         return list ? list->size : 0;
  78 }
  79
  80 struct strlist safe_alloc *strlist_alloc(bool uniq);
  81 const struct strlist_entry * never_null strlist_add(struct strlist *list, const char *str);
  82 const struct strlist_entry * printf_func(2, 3) never_null
  83         strlist_printf(struct strlist *list, const char *fmt, ...);
  84 const struct strlist_entry * never_null
  85         strlist_vprintf(struct strlist *list, const char *fmt, va_list ap);
  86 const struct strlist_entry *
  87 strlist_find(const struct strlist *list, const char *str);
  88 void * safe_alloc strlist_linearize(const struct strlist *list, char sep);
  89 void strlist_write(const struct strlist *list, const char *sep, FILE *f);
  90 void strlist_free(struct strlist **listp);
  91 #define strlist_for_each(p,h) list_for_each((p), strlist_head(h))
  92
  93 #endif /* NASM_STRLIST_H */