libmicrohttpd2

HTTP server C library (MHD 2.x, alpha)
Log | Files | Refs | README | LICENSE

mhd_str_types.h (2851B)

      1 /* SPDX-License-Identifier: LGPL-2.1-or-later OR (GPL-2.0-or-later WITH eCos-exception-2.0) */
      2 /*
      3   This file is part of GNU libmicrohttpd.
      4   Copyright (C) 2024-2025 Evgeny Grin (Karlson2k)
      5 
      6   GNU libmicrohttpd is free software; you can redistribute it and/or
      7   modify it under the terms of the GNU Lesser General Public
      8   License as published by the Free Software Foundation; either
      9   version 2.1 of the License, or (at your option) any later version.
     10 
     11   GNU libmicrohttpd is distributed in the hope that it will be useful,
     12   but WITHOUT ANY WARRANTY; without even the implied warranty of
     13   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
     14   Lesser General Public License for more details.
     15 
     16   Alternatively, you can redistribute GNU libmicrohttpd and/or
     17   modify it under the terms of the GNU General Public License as
     18   published by the Free Software Foundation; either version 2 of
     19   the License, or (at your option) any later version, together
     20   with the eCos exception, as follows:
     21 
     22     As a special exception, if other files instantiate templates or
     23     use macros or inline functions from this file, or you compile this
     24     file and link it with other works to produce a work based on this
     25     file, this file does not by itself cause the resulting work to be
     26     covered by the GNU General Public License. However the source code
     27     for this file must still be made available in accordance with
     28     section (3) of the GNU General Public License v2.
     29 
     30     This exception does not invalidate any other reasons why a work
     31     based on this file might be covered by the GNU General Public
     32     License.
     33 
     34   You should have received copies of the GNU Lesser General Public
     35   License and the GNU General Public License along with this library;
     36   if not, see <https://www.gnu.org/licenses/>.
     37 */
     38 
     39 /**
     40  * @file src/mhd2/mhd_str_types.h
     41  * @brief  The definition of the MHD_String and MHD_StringNullable structs
     42  * @author Karlson2k (Evgeny Grin)
     43  */
     44 
     45 #ifndef MHD_STR_TYPES_H
     46 #define MHD_STR_TYPES_H 1
     47 
     48 #include "mhd_sys_options.h"
     49 
     50 #ifndef MHD_STRINGS_DEFINED
     51 #include "sys_sizet_type.h"
     52 
     53 
     54 /**
     55  * String with length data.
     56  * This type should always have valid @a cstr pointer.
     57  */
     58 struct MHD_String
     59 {
     60   /**
     61    * Number of characters in @e cstr, not counting 0-termination.
     62    */
     63   size_t len;
     64 
     65   /**
     66    * 0-terminated C-string.
     67    * Must not be NULL.
     68    */
     69   const char *cstr;
     70 };
     71 
     72 /**
     73  * String with length data.
     74  * This type of data may have NULL as the @a cstr pointer.
     75  */
     76 struct MHD_StringNullable
     77 {
     78   /**
     79    * Number of characters in @e cstr, not counting 0-termination.
     80    * If @a cstr is NULL, it must be zero.
     81    */
     82   size_t len;
     83 
     84   /**
     85    * 0-terminated C-string.
     86    * In some cases it could be NULL.
     87    */
     88   const char *cstr;
     89 };
     90 
     91 #define MHD_STRINGS_DEFINED 1
     92 #endif /* ! MHD_STRINGS_DEFINED */
     93 
     94 #endif /* ! MHD_STR_TYPES_H */