• Main Page
  • Related Pages
  • Modules
  • Data Structures
  • Files
  • File List
  • Globals

/home/pvrabec/project/openscap/openscap-0.6.6/src/common/util.h

00001 /*
00002  * Copyright 2009 Red Hat Inc., Durham, North Carolina.
00003  * All Rights Reserved.
00004  *
00005  * This library is free software; you can redistribute it and/or
00006  * modify it under the terms of the GNU Lesser General Public
00007  * License as published by the Free Software Foundation; either
00008  * version 2.1 of the License, or (at your option) any later version.
00009  *
00010  * This library is distributed in the hope that it will be useful,
00011  * but WITHOUT ANY WARRANTY; without even the implied warranty of
00012  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
00013  * Lesser General Public License for more details.
00014  *
00015  * You should have received a copy of the GNU Lesser General Public
00016  * License along with this library; if not, write to the Free Software
00017  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
00018  *
00019  * Authors:
00020  *      Lukas Kuklinek <lkuklinek@redhat.com>
00021  */
00022 
00023 
00024 #ifndef OSCAP_UTIL_H_
00025 #define OSCAP_UTIL_H_
00026 
00027 #include <stdbool.h>
00028 #include <assert.h>
00029 #include "public/oscap.h"
00030 #include "public/alloc.h"
00031 
00032 #define __attribute__nonnull__(x) assert((x) != NULL)
00033 
00034 /*
00035  * Start a list of declarations that should not be available from outside the
00036  * library.  Must be matched with OSCAP_HIDDEN_END.
00037  */
00038 #define OSCAP_HIDDEN_START _Pragma("GCC visibility push(hidden)")
00039 
00040 /*
00041  * Start a list of declarations that should not be available from outside the
00042  * library started by OSCAP_HIDDEN_END.
00043  */
00044 #define OSCAP_HIDDEN_END _Pragma("GCC visibility pop")
00045 
00046 OSCAP_HIDDEN_START
00047 
00051 typedef void (*oscap_destruct_func) (void *);
00052 
00056 typedef void* (*oscap_clone_func) (void *);
00057 
00061 typedef void (*oscap_consumer_func) (void *, void *);
00062 
00073 #define OSCAP_GENERIC_GETTER_CONV(RTYPE,CONV,SNAME,MNAME,MEXP) \
00074         RTYPE SNAME##_get_##MNAME(const struct SNAME* item) { return (CONV(item->MEXP)); }
00075 
00084 #define OSCAP_GENERIC_GETTER(RTYPE,SNAME,MNAME,MEXP) \
00085         OSCAP_GENERIC_GETTER_CONV(RTYPE,,SNAME,MNAME,MEXP)
00086 
00095 #define OSCAP_GENERIC_GETTER_FORCE(RTYPE,SNAME,MNAME,MEXP) \
00096         OSCAP_GENERIC_GETTER_CONV(RTYPE,(RTYPE),SNAME,MNAME,MEXP)
00097 
00106 #define OSCAP_GETTER_FORCE(RTYPE,SNAME,MNAME) \
00107         OSCAP_GENERIC_GETTER_FORCE(RTYPE,SNAME,MNAME,MNAME)
00108 
00117 #define OSCAP_GETTER(RTYPE,SNAME,MNAME) \
00118         OSCAP_GENERIC_GETTER(RTYPE,SNAME,MNAME,MNAME)
00119 
00120 #define ITERATOR_CAST(x) ((struct oscap_iterator*)(x))
00121 #define OSCAP_ITERATOR(n) struct n##_iterator*
00122 #define OSCAP_ITERATOR_FWD(n) struct n##_iterator;
00123 #define OSCAP_ITERATOR_HAS_MORE(n) bool n##_iterator_has_more(OSCAP_ITERATOR(n) it) { return oscap_iterator_has_more(ITERATOR_CAST(it)); }
00124 #define OSCAP_ITERATOR_NEXT(t,n) t n##_iterator_next(OSCAP_ITERATOR(n) it) { return oscap_iterator_next(ITERATOR_CAST(it)); }
00125 #define OSCAP_ITERATOR_FREE(n) void n##_iterator_free(OSCAP_ITERATOR(n) it) { oscap_iterator_free(ITERATOR_CAST(it)); }
00126 #define OSCAP_ITERATOR_RESET(n) void n##_iterator_reset(OSCAP_ITERATOR(n) it) { oscap_iterator_reset(ITERATOR_CAST(it)); }
00127 #define OSCAP_ITERATOR_DETACH(t,n) t n##_iterator_detach(OSCAP_ITERATOR(n) it) { return oscap_iterator_detach(ITERATOR_CAST(it)); }
00128 #define OSCAP_ITERATOR_GEN_T(t,n) OSCAP_ITERATOR_FWD(n) OSCAP_ITERATOR_HAS_MORE(n) OSCAP_ITERATOR_NEXT(t,n) OSCAP_ITERATOR_FREE(n)
00129 #define OSCAP_ITERATOR_GEN(n) OSCAP_ITERATOR_GEN_T(struct n*,n)
00130 
00131 #define OSCAP_ITERATOR_REMOVE_T(t,n,destructor) \
00132                 void n##_iterator_remove(OSCAP_ITERATOR(n) it) { destructor(oscap_iterator_detach(ITERATOR_CAST(it))); }
00133 #define OSCAP_ITERATOR_REMOVE(n,destructor) OSCAP_ITERATOR_REMOVE_T(struct n*,n,destructor)
00134 #define OSCAP_ITERATOR_REMOVE_F(n) OSCAP_ITERATOR_REMOVE(n, n##_free)
00135 
00136 
00146 #define OSCAP_IGETTER_CONV(ITYPE,SNAME,MNAME,CONV) \
00147         struct ITYPE##_iterator* SNAME##_get_##MNAME(const struct SNAME* item) \
00148         { return oscap_iterator_new((CONV(item))->MNAME); }
00149 
00158 #define OSCAP_IGETTER(ITYPE,SNAME,MNAME) OSCAP_IGETTER_CONV(ITYPE,SNAME,MNAME,)
00159 
00165 #define OSCAP_IGETTER_GEN(ITYPE,SNAME,MNAME) OSCAP_IGETTER(ITYPE,SNAME,MNAME) OSCAP_ITERATOR_GEN(ITYPE)
00166 
00176 #define OSCAP_HGETTER_EXP(RTYPE,SNAME,MNAME,MEXP) \
00177         RTYPE SNAME##_get_##MNAME(const struct SNAME* item, const char* key) \
00178         { return oscap_htable_get(item->MEXP, key); }
00179 
00188 #define OSCAP_HGETTER(RTYPE,SNAME,MNAME) OSCAP_HGETTER_EXP(RTYPE,SNAME,MNAME,MNAME)
00189 
00198 #define OSCAP_HGETTER_STRUCT(RTYPE,SNAME,MNAME) OSCAP_HGETTER_EXP(struct RTYPE*,SNAME,MNAME,MNAME)
00199 
00200 #define OSCAP_SETTER_HEADER(SNAME, MTYPE, MNAME) bool SNAME##_set_##MNAME(struct SNAME *obj, MTYPE newval)
00201 
00213 #define OSCAP_SETTER_GENERIC_CHECK(SNAME, MTYPE, MNAME, CHECK, DELETER, ASSIGNER) \
00214         OSCAP_SETTER_HEADER(SNAME, MTYPE, MNAME) \
00215         { if (!(CHECK)) return false; DELETER(obj->MNAME); obj->MNAME = ASSIGNER(newval); return true; }
00216 
00221 #define OSCAP_SETTER_GENERIC(SNAME, MTYPE, MNAME, DELETER, ASSIGNER) \
00222         OSCAP_SETTER_HEADER(SNAME, MTYPE, MNAME) \
00223         { DELETER(obj->MNAME); obj->MNAME = ASSIGNER(newval); return true; }
00224 
00229 #define OSCAP_SETTER_GENERIC_NODELETE(SNAME, MTYPE, MNAME, ASSIGNER) \
00230         OSCAP_SETTER_HEADER(SNAME, MTYPE, MNAME) \
00231         { obj->MNAME = ASSIGNER(newval); return true; }
00232 
00237 #define OSCAP_SETTER_SIMPLE(SNAME, MTYPE, MNAME) \
00238         OSCAP_SETTER_GENERIC_NODELETE(SNAME, MTYPE, MNAME, )
00239 
00245 #define OSCAP_SETTER_STRING(SNAME, MNAME) \
00246         OSCAP_SETTER_GENERIC(SNAME, const char *, MNAME, free, oscap_strdup)
00247 
00251 #define OSCAP_ACCESSOR_STRING(SNAME, MNAME) \
00252         OSCAP_GETTER(const char*, SNAME, MNAME) OSCAP_SETTER_STRING(SNAME, MNAME)
00253 
00257 #define OSCAP_ACCESSOR_TEXT(SNAME, MNAME) \
00258         OSCAP_GETTER(struct oscap_text *, SNAME, MNAME) \
00259     OSCAP_SETTER_GENERIC(SNAME, struct oscap_text*, MNAME, oscap_text_free, )
00260 
00264 #define OSCAP_ACCESSOR_SIMPLE(MTYPE, SNAME, MNAME) \
00265         OSCAP_GETTER(MTYPE, SNAME, MNAME) OSCAP_SETTER_SIMPLE(SNAME, MTYPE, MNAME)
00266 
00271 #define OSCAP_ACCESSOR_EXP(MTYPE, SNAME, MNAME, MEXP) \
00272     OSCAP_GENERIC_GETTER(MTYPE, SNAME, MNAME, MEXP) \
00273     OSCAP_SETTER_HEADER(SNAME, MTYPE, MNAME) { obj->MEXP = newval; return true; }
00274 
00284 #define OSCAP_INSERTER(SNAME, FNAME, MTYPE, MNAME) \
00285         bool SNAME##_add_##FNAME(struct SNAME *obj, struct MTYPE *item) \
00286         { oscap_list_add(obj->MNAME, item); return true; }
00287 
00288 /* Generate iterator getter and list inserter */
00289 #define OSCAP_IGETINS(ITYPE, SNAME, MNAME, FNAME) \
00290         OSCAP_IGETTER(ITYPE, SNAME, MNAME) OSCAP_INSERTER(SNAME, FNAME, ITYPE, MNAME)
00291 /* Generate iterator getter, list inserter, and iterator manipulation functions. */
00292 #define OSCAP_IGETINS_GEN(ITYPE, SNAME, MNAME, FNAME) \
00293         OSCAP_IGETTER_GEN(ITYPE, SNAME, MNAME) OSCAP_INSERTER(SNAME, FNAME, ITYPE, MNAME)
00294 
00302 struct oscap_string_map {
00303         int value;              /* integer/enum value */
00304         const char *string;     /* string representation of the value */
00305 };
00306 
00313 int oscap_string_to_enum(const struct oscap_string_map *map, const char *str);
00314 
00321 const char *oscap_enum_to_string(const struct oscap_string_map *map, int val);
00322 
00327 char *oscap_strdup(const char *str);
00328 
00335 char *oscap_strsep(char **str, const char *delim);
00336 
00345 char **oscap_split(char *str, const char *delim);
00346 
00347 
00349 int oscap_strcmp(const char *s1, const char *s2);
00351 bool oscap_streq(const char *s1, const char *s2);
00353 char *oscap_trim(char *str);
00355 char *oscap_vsprintf(const char *fmt, va_list ap);
00357 char *oscap_sprintf(const char *fmt, ...);
00359 const char *oscap_strlist_find_value(char ** const kvalues, const char *key);
00360 
00361 // check pointer equality
00362 bool oscap_ptr_cmp(void *node1, void *node2);
00363 
00364 // validate given XML file
00365 bool oscap_validate_xml(const char *xmlfile, const char *schemafile, oscap_reporter reporter, void *arg);
00366 // check file existence
00367 bool oscap_file_exists(const char *path, int mode);
00368 
00376 char *oscap_find_file(const char *filename, int mode, const char *pathvar, const char *path);
00377 
00378 
00379 #ifndef OSCAP_CONCAT
00380 # define OSCAP_CONCAT1(a,b) a ## b
00381 # define OSCAP_CONCAT(a,b) OSCAP_CONCAT1(a,b)
00382 #endif
00383 
00384 #define OSCAP_GSYM(s) OSCAP_CONCAT(___G_, s)
00385 
00386 #define protect_errno                                                   \
00387         for (int OSCAP_CONCAT(__e,__LINE__)=errno, OSCAP_CONCAT(__s,__LINE__)=1; OSCAP_CONCAT(__s,__LINE__)--; errno=OSCAP_CONCAT(__e,__LINE__))
00388 
00389 OSCAP_HIDDEN_END;
00390 
00391 #endif                          /* OSCAP_UTIL_H_ */

Generated on Thu Dec 9 2010 for Open SCAP Library by  doxygen 1.7.1