1  /* Output stream that accumulates the output in memory.
       2     Copyright (C) 2006, 2019-2020 Free Software Foundation, Inc.
       3     Written by Bruno Haible <bruno@clisp.org>, 2006.
       4  
       5     This program is free software: you can redistribute it and/or modify
       6     it under the terms of the GNU General Public License as published by
       7     the Free Software Foundation; either version 3 of the License, or
       8     (at your option) any later version.
       9  
      10     This program is distributed in the hope that it will be useful,
      11     but WITHOUT ANY WARRANTY; without even the implied warranty of
      12     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
      13     GNU General Public License for more details.
      14  
      15     You should have received a copy of the GNU General Public License
      16     along with this program.  If not, see <https://www.gnu.org/licenses/>.  */
      17  
      18  #ifndef _MEMORY_OSTREAM_H
      19  #define _MEMORY_OSTREAM_H
      20  
      21  #include <stdbool.h>
      22  #include <stddef.h>
      23  
      24  #include "ostream.h"
      25  
      26  struct memory_ostream : struct ostream
      27  {
      28  methods:
      29    /* Return a pointer to the output accumulated so far and its size:
      30       Store them in *BUFP and *BUFLENP.
      31       Note: These two return values become invalid when more output is done to
      32       the stream or when the stream is freed.  */
      33    void contents (memory_ostream_t stream, const void **bufp, size_t *buflenp);
      34  };
      35  
      36  #ifdef __cplusplus
      37  extern "C" {
      38  #endif
      39  
      40  
      41  /* Create an output stream that accumulates the output in a memory buffer.  */
      42  extern memory_ostream_t memory_ostream_create (void);
      43  
      44  
      45  /* Test whether a given output stream is a memory_ostream.  */
      46  extern bool is_instance_of_memory_ostream (ostream_t stream);
      47  
      48  
      49  #ifdef __cplusplus
      50  }
      51  #endif
      52  
      53  #endif /* _MEMORY_OSTREAM_H */