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