1 /* 2 * This file is part of gtkD. 3 * 4 * gtkD is free software; you can redistribute it and/or modify 5 * it under the terms of the GNU Lesser General Public License 6 * as published by the Free Software Foundation; either version 3 7 * of the License, or (at your option) any later version, with 8 * some exceptions, please read the COPYING file. 9 * 10 * gtkD 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 Lesser General Public License for more details. 14 * 15 * You should have received a copy of the GNU Lesser General Public License 16 * along with gtkD; if not, write to the Free Software 17 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110, USA 18 */ 19 20 // generated automatically - do not change 21 // find conversion definition on APILookup.txt 22 // implement new conversion functionalities on the wrap.utils pakage 23 24 25 module gio.ConverterT; 26 27 public import gio.c.functions; 28 public import gio.c.types; 29 public import glib.ErrorG; 30 public import glib.GException; 31 public import gtkc.giotypes; 32 33 34 /** 35 * #GConverter is implemented by objects that convert 36 * binary data in various ways. The conversion can be 37 * stateful and may fail at any place. 38 * 39 * Some example conversions are: character set conversion, 40 * compression, decompression and regular expression 41 * replace. 42 * 43 * Since: 2.24 44 */ 45 public template ConverterT(TStruct) 46 { 47 /** Get the main Gtk struct */ 48 public GConverter* getConverterStruct(bool transferOwnership = false) 49 { 50 if (transferOwnership) 51 ownedRef = false; 52 return cast(GConverter*)getStruct(); 53 } 54 55 56 /** 57 * This is the main operation used when converting data. It is to be called 58 * multiple times in a loop, and each time it will do some work, i.e. 59 * producing some output (in @outbuf) or consuming some input (from @inbuf) or 60 * both. If its not possible to do any work an error is returned. 61 * 62 * Note that a single call may not consume all input (or any input at all). 63 * Also a call may produce output even if given no input, due to state stored 64 * in the converter producing output. 65 * 66 * If any data was either produced or consumed, and then an error happens, then 67 * only the successful conversion is reported and the error is returned on the 68 * next call. 69 * 70 * A full conversion loop involves calling this method repeatedly, each time 71 * giving it new input and space output space. When there is no more input 72 * data after the data in @inbuf, the flag %G_CONVERTER_INPUT_AT_END must be set. 73 * The loop will be (unless some error happens) returning %G_CONVERTER_CONVERTED 74 * each time until all data is consumed and all output is produced, then 75 * %G_CONVERTER_FINISHED is returned instead. Note, that %G_CONVERTER_FINISHED 76 * may be returned even if %G_CONVERTER_INPUT_AT_END is not set, for instance 77 * in a decompression converter where the end of data is detectable from the 78 * data (and there might even be other data after the end of the compressed data). 79 * 80 * When some data has successfully been converted @bytes_read and is set to 81 * the number of bytes read from @inbuf, and @bytes_written is set to indicate 82 * how many bytes was written to @outbuf. If there are more data to output 83 * or consume (i.e. unless the %G_CONVERTER_INPUT_AT_END is specified) then 84 * %G_CONVERTER_CONVERTED is returned, and if no more data is to be output 85 * then %G_CONVERTER_FINISHED is returned. 86 * 87 * On error %G_CONVERTER_ERROR is returned and @error is set accordingly. 88 * Some errors need special handling: 89 * 90 * %G_IO_ERROR_NO_SPACE is returned if there is not enough space 91 * to write the resulting converted data, the application should 92 * call the function again with a larger @outbuf to continue. 93 * 94 * %G_IO_ERROR_PARTIAL_INPUT is returned if there is not enough 95 * input to fully determine what the conversion should produce, 96 * and the %G_CONVERTER_INPUT_AT_END flag is not set. This happens for 97 * example with an incomplete multibyte sequence when converting text, 98 * or when a regexp matches up to the end of the input (and may match 99 * further input). It may also happen when @inbuf_size is zero and 100 * there is no more data to produce. 101 * 102 * When this happens the application should read more input and then 103 * call the function again. If further input shows that there is no 104 * more data call the function again with the same data but with 105 * the %G_CONVERTER_INPUT_AT_END flag set. This may cause the conversion 106 * to finish as e.g. in the regexp match case (or, to fail again with 107 * %G_IO_ERROR_PARTIAL_INPUT in e.g. a charset conversion where the 108 * input is actually partial). 109 * 110 * After g_converter_convert() has returned %G_CONVERTER_FINISHED the 111 * converter object is in an invalid state where its not allowed 112 * to call g_converter_convert() anymore. At this time you can only 113 * free the object or call g_converter_reset() to reset it to the 114 * initial state. 115 * 116 * If the flag %G_CONVERTER_FLUSH is set then conversion is modified 117 * to try to write out all internal state to the output. The application 118 * has to call the function multiple times with the flag set, and when 119 * the available input has been consumed and all internal state has 120 * been produced then %G_CONVERTER_FLUSHED (or %G_CONVERTER_FINISHED if 121 * really at the end) is returned instead of %G_CONVERTER_CONVERTED. 122 * This is somewhat similar to what happens at the end of the input stream, 123 * but done in the middle of the data. 124 * 125 * This has different meanings for different conversions. For instance 126 * in a compression converter it would mean that we flush all the 127 * compression state into output such that if you uncompress the 128 * compressed data you get back all the input data. Doing this may 129 * make the final file larger due to padding though. Another example 130 * is a regexp conversion, where if you at the end of the flushed data 131 * have a match, but there is also a potential longer match. In the 132 * non-flushed case we would ask for more input, but when flushing we 133 * treat this as the end of input and do the match. 134 * 135 * Flushing is not always possible (like if a charset converter flushes 136 * at a partial multibyte sequence). Converters are supposed to try 137 * to produce as much output as possible and then return an error 138 * (typically %G_IO_ERROR_PARTIAL_INPUT). 139 * 140 * Params: 141 * inbuf = the buffer 142 * containing the data to convert. 143 * outbuf = a buffer to write 144 * converted data in. 145 * flags = a #GConverterFlags controlling the conversion details 146 * bytesRead = will be set to the number of bytes read from @inbuf on success 147 * bytesWritten = will be set to the number of bytes written to @outbuf on success 148 * 149 * Returns: a #GConverterResult, %G_CONVERTER_ERROR on error. 150 * 151 * Since: 2.24 152 * 153 * Throws: GException on failure. 154 */ 155 public GConverterResult convert(ubyte[] inbuf, ubyte[] outbuf, GConverterFlags flags, out size_t bytesRead, out size_t bytesWritten) 156 { 157 GError* err = null; 158 159 auto __p = g_converter_convert(getConverterStruct(), inbuf.ptr, cast(size_t)inbuf.length, outbuf.ptr, cast(size_t)outbuf.length, flags, &bytesRead, &bytesWritten, &err); 160 161 if (err !is null) 162 { 163 throw new GException( new ErrorG(err) ); 164 } 165 166 return __p; 167 } 168 169 /** 170 * Resets all internal state in the converter, making it behave 171 * as if it was just created. If the converter has any internal 172 * state that would produce output then that output is lost. 173 * 174 * Since: 2.24 175 */ 176 public void reset() 177 { 178 g_converter_reset(getConverterStruct()); 179 } 180 }