Coverage Report

Created: 2026-10-14 08:19

next uncovered line (L), next uncovered region (R), next uncovered branch (B)
/src/glib-2.88.3/glib/giochannel.c
Line
Count
Source
1
/* GLIB - Library of useful routines for C programming
2
 * Copyright (C) 1995-1997  Peter Mattis, Spencer Kimball and Josh MacDonald
3
 *
4
 * giochannel.c: IO Channel abstraction
5
 * Copyright 1998 Owen Taylor
6
 *
7
 * SPDX-License-Identifier: LGPL-2.1-or-later
8
 *
9
 * This library is free software; you can redistribute it and/or
10
 * modify it under the terms of the GNU Lesser General Public
11
 * License as published by the Free Software Foundation; either
12
 * version 2.1 of the License, or (at your option) any later version.
13
 *
14
 * This library is distributed in the hope that it will be useful,
15
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
17
 * Lesser General Public License for more details.
18
 *
19
 * You should have received a copy of the GNU Lesser General Public
20
 * License along with this library; if not, see <http://www.gnu.org/licenses/>.
21
 */
22
23
/*
24
 * Modified by the GLib Team and others 1997-2000.  See the AUTHORS
25
 * file for a list of people on the GLib Team.  See the ChangeLog
26
 * files for a list of changes.  These files are distributed with
27
 * GLib at ftp://ftp.gtk.org/pub/gtk/. 
28
 */
29
30
/* 
31
 * MT safe
32
 */
33
34
#include "config.h"
35
36
#include <string.h>
37
#include <errno.h>
38
39
#include "giochannel.h"
40
41
#include "gstrfuncs.h"
42
#include "gtestutils.h"
43
#include "glibintl.h"
44
45
46
/**
47
 * GIOChannel:
48
 *
49
 * The `GIOChannel` data type aims to provide a portable method for
50
 * using file descriptors, pipes, and sockets, and integrating them
51
 * into the main event loop (see [struct@GLib.MainContext]). Currently,
52
 * full support is available on UNIX platforms; support for Windows
53
 * is only partially complete.
54
 *
55
 * To create a new `GIOChannel` on UNIX systems use
56
 * [ctor@GLib.IOChannel.unix_new]. This works for plain file descriptors,
57
 * pipes and sockets. Alternatively, a channel can be created for a
58
 * file in a system independent manner using [ctor@GLib.IOChannel.new_file].
59
 *
60
 * Once a `GIOChannel` has been created, it can be used in a generic
61
 * manner with the functions [method@GLib.IOChannel.read_chars],
62
 * [method@GLib.IOChannel.write_chars], [method@GLib.IOChannel.seek_position],
63
 * and [method@GLib.IOChannel.shutdown].
64
 *
65
 * To add a `GIOChannel` to the main event loop, use [func@GLib.io_add_watch] or
66
 * [func@GLib.io_add_watch_full]. Here you specify which events you are
67
 * interested in on the `GIOChannel`, and provide a function to be called
68
 * whenever these events occur.
69
 *
70
 * `GIOChannel` instances are created with an initial reference count of 1.
71
 * [method@GLib.IOChannel.ref] and [method@GLib.IOChannel.unref] can be used to
72
 * increment or decrement the reference count respectively. When the
73
 * reference count falls to 0, the `GIOChannel` is freed. (Though it
74
 * isn’t closed automatically, unless it was created using
75
 * [ctor@GLib.IOChannel.new_file].) Using [func@GLib.io_add_watch] or
76
 * [func@GLib.io_add_watch_full] increments a channel’s reference count.
77
 *
78
 * The new functions [method@GLib.IOChannel.read_chars],
79
 * [method@GLib.IOChannel.read_line], [method@GLib.IOChannel.read_line_string],
80
 * [method@GLib.IOChannel.read_to_end], [method@GLib.IOChannel.write_chars],
81
 * [method@GLib.IOChannel.seek_position], and [method@GLib.IOChannel.flush]
82
 * should not be mixed with the deprecated functions
83
 * [method@GLib.IOChannel.read], [method@GLib.IOChannel.write], and
84
 * [method@GLib.IOChannel.seek] on the same channel.
85
 **/
86
87
/**
88
 * GIOFuncs:
89
 * @io_read: reads raw bytes from the channel.  This is called from
90
 *           various functions such as g_io_channel_read_chars() to
91
 *           read raw bytes from the channel.  Encoding and buffering
92
 *           issues are dealt with at a higher level.
93
 * @io_write: writes raw bytes to the channel.  This is called from
94
 *            various functions such as g_io_channel_write_chars() to
95
 *            write raw bytes to the channel.  Encoding and buffering
96
 *            issues are dealt with at a higher level.
97
 * @io_seek: (optional): seeks the channel.  This is called from
98
 *           g_io_channel_seek() on channels that support it.
99
 * @io_close: closes the channel.  This is called from
100
 *            g_io_channel_close() after flushing the buffers.
101
 * @io_create_watch: creates a watch on the channel.  This call
102
 *                   corresponds directly to g_io_create_watch().
103
 * @io_free: called from g_io_channel_unref() when the channel needs to
104
 *           be freed.  This function must free the memory associated
105
 *           with the channel, including freeing the #GIOChannel
106
 *           structure itself.  The channel buffers have been flushed
107
 *           and possibly @io_close has been called by the time this
108
 *           function is called.
109
 * @io_set_flags: sets the #GIOFlags on the channel.  This is called
110
 *                from g_io_channel_set_flags() with all flags except
111
 *                for %G_IO_FLAG_APPEND and %G_IO_FLAG_NONBLOCK masked
112
 *                out.
113
 * @io_get_flags: gets the #GIOFlags for the channel.  This function
114
 *                need only return the %G_IO_FLAG_APPEND and
115
 *                %G_IO_FLAG_NONBLOCK flags; g_io_channel_get_flags()
116
 *                automatically adds the others as appropriate.
117
 *
118
 * A table of functions used to handle different types of #GIOChannel
119
 * in a generic way.
120
 **/
121
122
/**
123
 * GIOStatus:
124
 * @G_IO_STATUS_ERROR: An error occurred.
125
 * @G_IO_STATUS_NORMAL: Success.
126
 * @G_IO_STATUS_EOF: End of file.
127
 * @G_IO_STATUS_AGAIN: Resource temporarily unavailable.
128
 *
129
 * Statuses returned by most of the #GIOFuncs functions.
130
 **/
131
132
/**
133
 * GIOError:
134
 * @G_IO_ERROR_NONE: no error
135
 * @G_IO_ERROR_AGAIN: an EAGAIN error occurred
136
 * @G_IO_ERROR_INVAL: an EINVAL error occurred
137
 * @G_IO_ERROR_UNKNOWN: another error occurred
138
 *
139
 * #GIOError is only used by the deprecated functions
140
 * g_io_channel_read(), g_io_channel_write(), and g_io_channel_seek().
141
 **/
142
143
0
#define G_IO_NICE_BUF_SIZE  1024
144
145
/* This needs to be as wide as the largest character in any possible encoding */
146
0
#define MAX_CHAR_SIZE   10
147
148
/* Some simplifying macros, which reduce the need to worry whether the
149
 * buffers have been allocated. These also make USE_BUF () an lvalue,
150
 * which is used in g_io_channel_read_to_end ().
151
 */
152
0
#define USE_BUF(channel)  ((channel)->encoding ? (channel)->encoded_read_buf \
153
0
         : (channel)->read_buf)
154
0
#define BUF_LEN(string)   ((string) ? (string)->len : 0)
155
156
static GIOError   g_io_error_get_from_g_error (GIOStatus    status,
157
               GError      *err);
158
static void   g_io_channel_purge    (GIOChannel  *channel);
159
static GIOStatus  g_io_channel_fill_buffer  (GIOChannel  *channel,
160
               GError     **err);
161
static GIOStatus  g_io_channel_read_line_backend  (GIOChannel  *channel,
162
               gsize       *length,
163
               gsize       *terminator_pos,
164
               GError     **error);
165
166
/**
167
 * g_io_channel_init:
168
 * @channel: a #GIOChannel
169
 *
170
 * Initializes a #GIOChannel struct. 
171
 *
172
 * This is called by each of the above functions when creating a 
173
 * #GIOChannel, and so is not often needed by the application 
174
 * programmer (unless you are creating a new type of #GIOChannel).
175
 */
176
void
177
g_io_channel_init (GIOChannel *channel)
178
0
{
179
0
  channel->ref_count = 1;
180
0
  channel->encoding = g_strdup ("UTF-8");
181
0
  channel->line_term = NULL;
182
0
  channel->line_term_len = 0;
183
0
  channel->buf_size = G_IO_NICE_BUF_SIZE;
184
0
  channel->read_cd = (GIConv) -1;
185
0
  channel->write_cd = (GIConv) -1;
186
0
  channel->read_buf = NULL; /* Lazy allocate buffers */
187
0
  channel->encoded_read_buf = NULL;
188
0
  channel->write_buf = NULL;
189
0
  channel->partial_write_buf[0] = '\0';
190
0
  channel->use_buffer = TRUE;
191
0
  channel->do_encode = FALSE;
192
0
  channel->close_on_unref = FALSE;
193
0
}
194
195
/**
196
 * g_io_channel_ref:
197
 * @channel: a #GIOChannel
198
 *
199
 * Increments the reference count of a #GIOChannel.
200
 *
201
 * Returns: the @channel that was passed in (since 2.6)
202
 */
203
GIOChannel *
204
g_io_channel_ref (GIOChannel *channel)
205
0
{
206
0
  g_return_val_if_fail (channel != NULL, NULL);
207
208
0
  g_atomic_int_inc (&channel->ref_count);
209
210
0
  return channel;
211
0
}
212
213
/**
214
 * g_io_channel_unref:
215
 * @channel: a #GIOChannel
216
 *
217
 * Decrements the reference count of a #GIOChannel.
218
 */
219
void 
220
g_io_channel_unref (GIOChannel *channel)
221
0
{
222
0
  gboolean is_zero;
223
224
0
  g_return_if_fail (channel != NULL);
225
226
0
  is_zero = g_atomic_int_dec_and_test (&channel->ref_count);
227
228
0
  if (G_UNLIKELY (is_zero))
229
0
    {
230
0
      if (channel->close_on_unref)
231
0
        g_io_channel_shutdown (channel, TRUE, NULL);
232
0
      else
233
0
        g_io_channel_purge (channel);
234
0
      g_free (channel->encoding);
235
0
      if (channel->read_cd != (GIConv) -1)
236
0
        g_iconv_close (channel->read_cd);
237
0
      if (channel->write_cd != (GIConv) -1)
238
0
        g_iconv_close (channel->write_cd);
239
0
      g_free (channel->line_term);
240
0
      if (channel->read_buf)
241
0
        g_string_free (channel->read_buf, TRUE);
242
0
      if (channel->write_buf)
243
0
        g_string_free (channel->write_buf, TRUE);
244
0
      if (channel->encoded_read_buf)
245
0
        g_string_free (channel->encoded_read_buf, TRUE);
246
0
      channel->funcs->io_free (channel);
247
0
    }
248
0
}
249
250
static GIOError
251
g_io_error_get_from_g_error (GIOStatus  status,
252
           GError    *err)
253
0
{
254
0
  switch (status)
255
0
    {
256
0
      case G_IO_STATUS_NORMAL:
257
0
      case G_IO_STATUS_EOF:
258
0
        return G_IO_ERROR_NONE;
259
0
      case G_IO_STATUS_AGAIN:
260
0
        return G_IO_ERROR_AGAIN;
261
0
      case G_IO_STATUS_ERROR:
262
0
  g_return_val_if_fail (err != NULL, G_IO_ERROR_UNKNOWN);
263
  
264
0
        if (err->domain != G_IO_CHANNEL_ERROR)
265
0
          return G_IO_ERROR_UNKNOWN;
266
0
        switch (err->code)
267
0
          {
268
0
            case G_IO_CHANNEL_ERROR_INVAL:
269
0
              return G_IO_ERROR_INVAL;
270
0
            default:
271
0
              return G_IO_ERROR_UNKNOWN;
272
0
          }
273
0
      default:
274
0
        g_assert_not_reached ();
275
0
    }
276
0
}
277
278
/**
279
 * g_io_channel_read:
280
 * @channel: a #GIOChannel
281
 * @buf: a buffer to read the data into (which should be at least 
282
 *       count bytes long)
283
 * @count: the number of bytes to read from the #GIOChannel
284
 * @bytes_read: returns the number of bytes actually read
285
 * 
286
 * Reads data from a #GIOChannel. 
287
 * 
288
 * Returns: %G_IO_ERROR_NONE if the operation was successful. 
289
 *
290
 * Deprecated:2.2: Use g_io_channel_read_chars() instead.
291
 **/
292
GIOError 
293
g_io_channel_read (GIOChannel *channel, 
294
       gchar      *buf, 
295
       gsize       count,
296
       gsize      *bytes_read)
297
0
{
298
0
  GError *err = NULL;
299
0
  GIOError error;
300
0
  GIOStatus status;
301
302
0
  g_return_val_if_fail (channel != NULL, G_IO_ERROR_UNKNOWN);
303
0
  g_return_val_if_fail (bytes_read != NULL, G_IO_ERROR_UNKNOWN);
304
305
0
  if (count == 0)
306
0
    {
307
0
      if (bytes_read)
308
0
        *bytes_read = 0;
309
0
      return G_IO_ERROR_NONE;
310
0
    }
311
312
0
  g_return_val_if_fail (buf != NULL, G_IO_ERROR_UNKNOWN);
313
314
0
  status = channel->funcs->io_read (channel, buf, count, bytes_read, &err);
315
316
0
  error = g_io_error_get_from_g_error (status, err);
317
318
0
  if (err)
319
0
    g_error_free (err);
320
321
0
  return error;
322
0
}
323
324
/**
325
 * g_io_channel_write:
326
 * @channel:  a #GIOChannel
327
 * @buf: the buffer containing the data to write
328
 * @count: the number of bytes to write
329
 * @bytes_written: the number of bytes actually written
330
 * 
331
 * Writes data to a #GIOChannel. 
332
 * 
333
 * Returns:  %G_IO_ERROR_NONE if the operation was successful.
334
 *
335
 * Deprecated:2.2: Use g_io_channel_write_chars() instead.
336
 **/
337
GIOError 
338
g_io_channel_write (GIOChannel  *channel, 
339
        const gchar *buf, 
340
        gsize        count,
341
        gsize       *bytes_written)
342
0
{
343
0
  GError *err = NULL;
344
0
  GIOError error;
345
0
  GIOStatus status;
346
347
0
  g_return_val_if_fail (channel != NULL, G_IO_ERROR_UNKNOWN);
348
0
  g_return_val_if_fail (bytes_written != NULL, G_IO_ERROR_UNKNOWN);
349
350
0
  status = channel->funcs->io_write (channel, buf, count, bytes_written, &err);
351
352
0
  error = g_io_error_get_from_g_error (status, err);
353
354
0
  if (err)
355
0
    g_error_free (err);
356
357
0
  return error;
358
0
}
359
360
/**
361
 * g_io_channel_seek:
362
 * @channel: a #GIOChannel
363
 * @offset: an offset, in bytes, which is added to the position specified 
364
 *          by @type
365
 * @type: the position in the file, which can be %G_SEEK_CUR (the current
366
 *        position), %G_SEEK_SET (the start of the file), or %G_SEEK_END 
367
 *        (the end of the file)
368
 * 
369
 * Sets the current position in the #GIOChannel, similar to the standard 
370
 * library function fseek(). 
371
 * 
372
 * Returns: %G_IO_ERROR_NONE if the operation was successful.
373
 *
374
 * Deprecated:2.2: Use g_io_channel_seek_position() instead.
375
 **/
376
GIOError 
377
g_io_channel_seek (GIOChannel *channel,
378
       gint64      offset, 
379
       GSeekType   type)
380
0
{
381
0
  GError *err = NULL;
382
0
  GIOError error;
383
0
  GIOStatus status;
384
385
0
  g_return_val_if_fail (channel != NULL, G_IO_ERROR_UNKNOWN);
386
0
  g_return_val_if_fail (channel->is_seekable, G_IO_ERROR_UNKNOWN);
387
388
0
  switch (type)
389
0
    {
390
0
      case G_SEEK_CUR:
391
0
      case G_SEEK_SET:
392
0
      case G_SEEK_END:
393
0
        break;
394
0
      default:
395
0
        g_warning ("g_io_channel_seek: unknown seek type");
396
0
        return G_IO_ERROR_UNKNOWN;
397
0
    }
398
399
0
  status = channel->funcs->io_seek (channel, offset, type, &err);
400
401
0
  error = g_io_error_get_from_g_error (status, err);
402
403
0
  if (err)
404
0
    g_error_free (err);
405
406
0
  return error;
407
0
}
408
409
/* The function g_io_channel_new_file() is prototyped in both
410
 * giounix.c and giowin32.c, so we stick its documentation here.
411
 */
412
413
/**
414
 * g_io_channel_new_file:
415
 * @filename: (type filename): A string containing the name of a file
416
 * @mode: One of "r", "w", "a", "r+", "w+", "a+". These have
417
 *        the same meaning as in fopen()
418
 * @error: A location to return an error of type %G_FILE_ERROR
419
 *
420
 * Open a file @filename as a #GIOChannel using mode @mode. This
421
 * channel will be closed when the last reference to it is dropped,
422
 * so there is no need to call g_io_channel_close() (though doing
423
 * so will not cause problems, as long as no attempt is made to
424
 * access the channel after it is closed).
425
 *
426
 * Returns: A #GIOChannel on success, %NULL on failure.
427
 **/
428
429
/**
430
 * g_io_channel_close:
431
 * @channel: A #GIOChannel
432
 * 
433
 * Close an IO channel. Any pending data to be written will be
434
 * flushed, ignoring errors. The channel will not be freed until the
435
 * last reference is dropped using g_io_channel_unref(). 
436
 *
437
 * Deprecated:2.2: Use g_io_channel_shutdown() instead.
438
 **/
439
void
440
g_io_channel_close (GIOChannel *channel)
441
0
{
442
0
  GError *err = NULL;
443
  
444
0
  g_return_if_fail (channel != NULL);
445
446
0
  g_io_channel_purge (channel);
447
448
0
  channel->funcs->io_close (channel, &err);
449
450
0
  if (err)
451
0
    { /* No way to return the error */
452
0
      g_warning ("Error closing channel: %s", err->message);
453
0
      g_error_free (err);
454
0
    }
455
  
456
0
  channel->close_on_unref = FALSE; /* Because we already did */
457
0
  channel->is_readable = FALSE;
458
0
  channel->is_writeable = FALSE;
459
0
  channel->is_seekable = FALSE;
460
0
}
461
462
/**
463
 * g_io_channel_shutdown:
464
 * @channel: a #GIOChannel
465
 * @flush: if %TRUE, flush pending
466
 * @err: location to store a #GIOChannelError
467
 * 
468
 * Close an IO channel. Any pending data to be written will be
469
 * flushed if @flush is %TRUE. The channel will not be freed until the
470
 * last reference is dropped using g_io_channel_unref().
471
 *
472
 * Returns: the status of the operation.
473
 **/
474
GIOStatus
475
g_io_channel_shutdown (GIOChannel  *channel,
476
           gboolean     flush,
477
           GError     **err)
478
0
{
479
0
  GIOStatus status, result;
480
0
  GError *tmperr = NULL;
481
  
482
0
  g_return_val_if_fail (channel != NULL, G_IO_STATUS_ERROR);
483
0
  g_return_val_if_fail (err == NULL || *err == NULL, G_IO_STATUS_ERROR);
484
485
0
  if (channel->write_buf && channel->write_buf->len > 0)
486
0
    {
487
0
      if (flush)
488
0
        {
489
0
          GIOFlags flags;
490
      
491
          /* Set the channel to blocking, to avoid a busy loop
492
           */
493
0
          flags = g_io_channel_get_flags (channel);
494
          /* Ignore any errors here, they're irrelevant */
495
0
          g_io_channel_set_flags (channel, flags & ~G_IO_FLAG_NONBLOCK, NULL);
496
497
0
          result = g_io_channel_flush (channel, &tmperr);
498
0
        }
499
0
      else
500
0
        result = G_IO_STATUS_NORMAL;
501
502
0
      g_string_truncate(channel->write_buf, 0);
503
0
    }
504
0
  else
505
0
    result = G_IO_STATUS_NORMAL;
506
507
0
  if (channel->partial_write_buf[0] != '\0')
508
0
    {
509
0
      if (flush)
510
0
        g_warning ("Partial character at end of write buffer not flushed.");
511
0
      channel->partial_write_buf[0] = '\0';
512
0
    }
513
514
0
  status = channel->funcs->io_close (channel, err);
515
516
0
  channel->close_on_unref = FALSE; /* Because we already did */
517
0
  channel->is_readable = FALSE;
518
0
  channel->is_writeable = FALSE;
519
0
  channel->is_seekable = FALSE;
520
521
0
  if (status != G_IO_STATUS_NORMAL)
522
0
    {
523
0
      g_clear_error (&tmperr);
524
0
      return status;
525
0
    }
526
0
  else if (result != G_IO_STATUS_NORMAL)
527
0
    {
528
0
      g_propagate_error (err, tmperr);
529
0
      return result;
530
0
    }
531
0
  else
532
0
    return G_IO_STATUS_NORMAL;
533
0
}
534
535
/* This function is used for the final flush on close or unref */
536
static void
537
g_io_channel_purge (GIOChannel *channel)
538
0
{
539
0
  GError *err = NULL;
540
0
  GIOStatus status G_GNUC_UNUSED;
541
542
0
  g_return_if_fail (channel != NULL);
543
544
0
  if (channel->write_buf && channel->write_buf->len > 0)
545
0
    {
546
0
      GIOFlags flags;
547
548
      /* Set the channel to blocking, to avoid a busy loop
549
       */
550
0
      flags = g_io_channel_get_flags (channel);
551
0
      g_io_channel_set_flags (channel, flags & ~G_IO_FLAG_NONBLOCK, NULL);
552
553
0
      status = g_io_channel_flush (channel, &err);
554
555
0
      if (err)
556
0
        { /* No way to return the error */
557
0
          g_warning ("Error flushing string: %s", err->message);
558
0
          g_error_free (err);
559
0
        }
560
0
    }
561
562
  /* Flush these in case anyone tries to close without unrefing */
563
564
0
  if (channel->read_buf)
565
0
    g_string_truncate (channel->read_buf, 0);
566
0
  if (channel->write_buf)
567
0
    g_string_truncate (channel->write_buf, 0);
568
0
  if (channel->encoding)
569
0
    {
570
0
      if (channel->encoded_read_buf)
571
0
        g_string_truncate (channel->encoded_read_buf, 0);
572
573
0
      if (channel->partial_write_buf[0] != '\0')
574
0
        {
575
0
          g_warning ("Partial character at end of write buffer not flushed.");
576
0
          channel->partial_write_buf[0] = '\0';
577
0
        }
578
0
    }
579
0
}
580
581
/**
582
 * g_io_create_watch:
583
 * @channel: a #GIOChannel to watch
584
 * @condition: conditions to watch for
585
 *
586
 * Creates a #GSource that's dispatched when @condition is met for the 
587
 * given @channel. For example, if condition is %G_IO_IN, the source will
588
 * be dispatched when there's data available for reading.
589
 *
590
 * The callback function invoked by the #GSource should be added with
591
 * g_source_set_callback(), but it has type #GIOFunc (not #GSourceFunc).
592
 *
593
 * g_io_add_watch() is a simpler interface to this same functionality, for 
594
 * the case where you want to add the source to the default main loop context 
595
 * at the default priority.
596
 *
597
 * On Windows, polling a #GSource created to watch a channel for a socket
598
 * puts the socket in non-blocking mode. This is a side-effect of the
599
 * implementation and unavoidable.
600
 *
601
 * Returns: a new #GSource
602
 */
603
GSource *
604
g_io_create_watch (GIOChannel   *channel,
605
       GIOCondition  condition)
606
0
{
607
0
  g_return_val_if_fail (channel != NULL, NULL);
608
609
0
  return channel->funcs->io_create_watch (channel, condition);
610
0
}
611
612
/**
613
 * g_io_add_watch_full: (rename-to g_io_add_watch)
614
 * @channel: a #GIOChannel
615
 * @priority: the priority of the #GIOChannel source
616
 * @condition: the condition to watch for
617
 * @func: the function to call when the condition is satisfied
618
 * @user_data: user data to pass to @func
619
 * @notify: the function to call when the source is removed
620
 *
621
 * Adds the #GIOChannel into the default main loop context
622
 * with the given priority.
623
 *
624
 * This internally creates a main loop source using g_io_create_watch()
625
 * and attaches it to the main loop context with g_source_attach().
626
 * You can do these steps manually if you need greater control.
627
 *
628
 * Returns: the event source id
629
 */
630
guint 
631
g_io_add_watch_full (GIOChannel    *channel,
632
         gint           priority,
633
         GIOCondition   condition,
634
         GIOFunc        func,
635
         gpointer       user_data,
636
         GDestroyNotify notify)
637
0
{
638
0
  GSource *source;
639
0
  guint id;
640
  
641
0
  g_return_val_if_fail (channel != NULL, 0);
642
643
0
  source = g_io_create_watch (channel, condition);
644
645
0
  if (priority != G_PRIORITY_DEFAULT)
646
0
    g_source_set_priority (source, priority);
647
0
  g_source_set_callback (source, (GSourceFunc)func, user_data, notify);
648
649
0
  id = g_source_attach (source, NULL);
650
0
  g_source_unref (source);
651
652
0
  return id;
653
0
}
654
655
/**
656
 * g_io_add_watch:
657
 * @channel: a #GIOChannel
658
 * @condition: the condition to watch for
659
 * @func: the function to call when the condition is satisfied
660
 * @user_data: user data to pass to @func
661
 *
662
 * Adds the #GIOChannel into the default main loop context
663
 * with the default priority.
664
 *
665
 * Returns: the event source id
666
 */
667
/**
668
 * GIOFunc:
669
 * @source: the #GIOChannel event source
670
 * @condition: the condition which has been satisfied
671
 * @data: user data set in g_io_add_watch() or g_io_add_watch_full()
672
 *
673
 * Specifies the type of function passed to g_io_add_watch() or
674
 * g_io_add_watch_full(), which is called when the requested condition
675
 * on a #GIOChannel is satisfied.
676
 *
677
 * Returns: the function should return %FALSE if the event source
678
 *          should be removed
679
 **/
680
/**
681
 * GIOCondition:
682
 * @G_IO_IN: There is data to read.
683
 * @G_IO_OUT: Data can be written (without blocking).
684
 * @G_IO_PRI: There is urgent data to read.
685
 * @G_IO_ERR: Error condition.
686
 * @G_IO_HUP: Hung up (the connection has been broken, usually for
687
 *            pipes and sockets).
688
 * @G_IO_NVAL: Invalid request. The file descriptor is not open.
689
 *
690
 * A bitwise combination representing a condition to watch for on an
691
 * event source.
692
 **/
693
guint 
694
g_io_add_watch (GIOChannel   *channel,
695
    GIOCondition  condition,
696
    GIOFunc       func,
697
    gpointer      user_data)
698
0
{
699
0
  return g_io_add_watch_full (channel, G_PRIORITY_DEFAULT, condition, func, user_data, NULL);
700
0
}
701
702
/**
703
 * g_io_channel_get_buffer_condition:
704
 * @channel: A #GIOChannel
705
 *
706
 * This function returns a #GIOCondition depending on whether there
707
 * is data to be read/space to write data in the internal buffers in 
708
 * the #GIOChannel. Only the flags %G_IO_IN and %G_IO_OUT may be set.
709
 *
710
 * Returns: A #GIOCondition
711
 **/
712
GIOCondition
713
g_io_channel_get_buffer_condition (GIOChannel *channel)
714
0
{
715
0
  GIOCondition condition = 0;
716
717
0
  if (channel->encoding)
718
0
    {
719
0
      if (channel->encoded_read_buf && (channel->encoded_read_buf->len > 0))
720
0
        condition |= G_IO_IN; /* Only return if we have full characters */
721
0
    }
722
0
  else
723
0
    {
724
0
      if (channel->read_buf && (channel->read_buf->len > 0))
725
0
        condition |= G_IO_IN;
726
0
    }
727
728
0
  if (channel->write_buf && (channel->write_buf->len < channel->buf_size))
729
0
    condition |= G_IO_OUT;
730
731
0
  return condition;
732
0
}
733
734
/**
735
 * g_io_channel_error_from_errno:
736
 * @en: an `errno` error number, e.g. `EINVAL`
737
 *
738
 * Converts an `errno` error number to a #GIOChannelError.
739
 *
740
 * Returns: a #GIOChannelError error number, e.g. 
741
 *      %G_IO_CHANNEL_ERROR_INVAL.
742
 **/
743
GIOChannelError
744
g_io_channel_error_from_errno (gint en)
745
0
{
746
0
#ifdef EAGAIN
747
0
  g_return_val_if_fail (en != EAGAIN, G_IO_CHANNEL_ERROR_FAILED);
748
0
#endif
749
750
0
  switch (en)
751
0
    {
752
0
#ifdef EBADF
753
0
    case EBADF:
754
0
      g_warning ("Invalid file descriptor.");
755
0
      return G_IO_CHANNEL_ERROR_FAILED;
756
0
#endif
757
758
0
#ifdef EFAULT
759
0
    case EFAULT:
760
0
      g_warning ("Buffer outside valid address space.");
761
0
      return G_IO_CHANNEL_ERROR_FAILED;
762
0
#endif
763
764
0
#ifdef EFBIG
765
0
    case EFBIG:
766
0
      return G_IO_CHANNEL_ERROR_FBIG;
767
0
#endif
768
769
0
#ifdef EINTR
770
    /* In general, we should catch EINTR before we get here,
771
     * but close() is allowed to return EINTR by POSIX, so
772
     * we need to catch it here; EINTR from close() is
773
     * unrecoverable, because it's undefined whether
774
     * the fd was actually closed or not, so we just return
775
     * a generic error code.
776
     */
777
0
    case EINTR:
778
0
      return G_IO_CHANNEL_ERROR_FAILED;
779
0
#endif
780
781
0
#ifdef EINVAL
782
0
    case EINVAL:
783
0
      return G_IO_CHANNEL_ERROR_INVAL;
784
0
#endif
785
786
0
#ifdef EIO
787
0
    case EIO:
788
0
      return G_IO_CHANNEL_ERROR_IO;
789
0
#endif
790
791
0
#ifdef EISDIR
792
0
    case EISDIR:
793
0
      return G_IO_CHANNEL_ERROR_ISDIR;
794
0
#endif
795
796
0
#ifdef ENOSPC
797
0
    case ENOSPC:
798
0
      return G_IO_CHANNEL_ERROR_NOSPC;
799
0
#endif
800
801
0
#ifdef ENXIO
802
0
    case ENXIO:
803
0
      return G_IO_CHANNEL_ERROR_NXIO;
804
0
#endif
805
806
0
#ifdef EOVERFLOW
807
0
#if EOVERFLOW != EFBIG
808
0
    case EOVERFLOW:
809
0
      return G_IO_CHANNEL_ERROR_OVERFLOW;
810
0
#endif
811
0
#endif
812
813
0
#ifdef EPIPE
814
0
    case EPIPE:
815
0
      return G_IO_CHANNEL_ERROR_PIPE;
816
0
#endif
817
818
0
    default:
819
0
      return G_IO_CHANNEL_ERROR_FAILED;
820
0
    }
821
0
}
822
823
/**
824
 * g_io_channel_set_buffer_size:
825
 * @channel: a #GIOChannel
826
 * @size: the size of the buffer, or 0 to let GLib pick a good size
827
 *
828
 * Sets the buffer size.
829
 **/  
830
void
831
g_io_channel_set_buffer_size (GIOChannel *channel,
832
                              gsize       size)
833
0
{
834
0
  g_return_if_fail (channel != NULL);
835
836
0
  if (size == 0)
837
0
    size = G_IO_NICE_BUF_SIZE;
838
839
0
  if (size < MAX_CHAR_SIZE)
840
0
    size = MAX_CHAR_SIZE;
841
842
0
  channel->buf_size = size;
843
0
}
844
845
/**
846
 * g_io_channel_get_buffer_size:
847
 * @channel: a #GIOChannel
848
 *
849
 * Gets the buffer size.
850
 *
851
 * Returns: the size of the buffer.
852
 **/  
853
gsize
854
g_io_channel_get_buffer_size (GIOChannel *channel)
855
0
{
856
0
  g_return_val_if_fail (channel != NULL, 0);
857
858
0
  return channel->buf_size;
859
0
}
860
861
/**
862
 * g_io_channel_set_line_term:
863
 * @channel: a #GIOChannel
864
 * @line_term: (nullable): The line termination string. Use %NULL for
865
 *             autodetect.  Autodetection breaks on "\n", "\r\n", "\r", "\0",
866
 *             and the Unicode paragraph separator. Autodetection should not be
867
 *             used for anything other than file-based channels.
868
 * @length: The length of the termination string. If -1 is passed, the
869
 *          string is assumed to be nul-terminated. This option allows
870
 *          termination strings with embedded nuls.
871
 *
872
 * This sets the string that #GIOChannel uses to determine
873
 * where in the file a line break occurs.
874
 **/
875
void
876
g_io_channel_set_line_term (GIOChannel  *channel,
877
                            const gchar *line_term,
878
          gint         length)
879
0
{
880
0
  g_return_if_fail (channel != NULL);
881
0
  g_return_if_fail (line_term == NULL || length != 0); /* Disallow "" */
882
883
0
  g_free (channel->line_term);
884
885
0
  if (line_term == NULL)
886
0
    {
887
0
      channel->line_term = NULL;
888
0
      channel->line_term_len = 0;
889
0
    }
890
0
  else if (length >= 0)
891
0
    {
892
      /* We store the value nul-terminated even if the input is not */
893
0
      channel->line_term = g_malloc0 (length + 1);
894
0
      memcpy (channel->line_term, line_term, length);
895
0
      channel->line_term_len = (guint) length;
896
0
    }
897
0
  else
898
0
    {
899
      /* We’re constrained by line_term_len being a guint here */
900
0
      gsize length_size = strlen (line_term);
901
0
      g_return_if_fail (length_size <= G_MAXUINT);
902
0
      channel->line_term = g_strdup (line_term);
903
0
      channel->line_term_len = (guint) length_size;
904
0
    }
905
0
}
906
907
/**
908
 * g_io_channel_get_line_term:
909
 * @channel: a #GIOChannel
910
 * @length: (out) (optional): a location to return the length of the line terminator
911
 *
912
 * This returns the string that #GIOChannel uses to determine
913
 * where in the file a line break occurs. A value of %NULL
914
 * indicates autodetection. Since 2.84, the return value is always
915
 * nul-terminated.
916
 *
917
 * Returns: The line termination string. This value
918
 *   is owned by GLib and must not be freed.
919
 **/
920
const gchar *
921
g_io_channel_get_line_term (GIOChannel *channel,
922
          gint       *length)
923
0
{
924
0
  g_return_val_if_fail (channel != NULL, NULL);
925
926
0
  if (length)
927
0
    *length = channel->line_term_len;
928
929
0
  return channel->line_term;
930
0
}
931
932
/**
933
 * g_io_channel_set_flags:
934
 * @channel: a #GIOChannel
935
 * @flags: the flags to set on the IO channel
936
 * @error: A location to return an error of type #GIOChannelError
937
 *
938
 * Sets the (writeable) flags in @channel to (@flags & %G_IO_FLAG_SET_MASK).
939
 *
940
 * Returns: the status of the operation. 
941
 **/
942
/**
943
 * GIOFlags:
944
 * @G_IO_FLAG_NONE: no special flags set. Since: 2.74
945
 * @G_IO_FLAG_APPEND: turns on append mode, corresponds to %O_APPEND
946
 *     (see the documentation of the UNIX open() syscall)
947
 * @G_IO_FLAG_NONBLOCK: turns on nonblocking mode, corresponds to
948
 *     %O_NONBLOCK/%O_NDELAY (see the documentation of the UNIX open()
949
 *     syscall)
950
 * @G_IO_FLAG_IS_READABLE: indicates that the io channel is readable.
951
 *     This flag cannot be changed.
952
 * @G_IO_FLAG_IS_WRITABLE: indicates that the io channel is writable.
953
 *     This flag cannot be changed.
954
 * @G_IO_FLAG_IS_WRITEABLE: a misspelled version of @G_IO_FLAG_IS_WRITABLE
955
 *     that existed before the spelling was fixed in GLib 2.30. It is kept
956
 *     here for compatibility reasons. Deprecated since 2.30
957
 * @G_IO_FLAG_IS_SEEKABLE: indicates that the io channel is seekable,
958
 *     i.e. that g_io_channel_seek_position() can be used on it.
959
 *     This flag cannot be changed.
960
 * @G_IO_FLAG_MASK: the mask that specifies all the valid flags.
961
 * @G_IO_FLAG_GET_MASK: the mask of the flags that are returned from
962
 *     g_io_channel_get_flags()
963
 * @G_IO_FLAG_SET_MASK: the mask of the flags that the user can modify
964
 *     with g_io_channel_set_flags()
965
 *
966
 * Specifies properties of a #GIOChannel. Some of the flags can only be
967
 * read with g_io_channel_get_flags(), but not changed with
968
 * g_io_channel_set_flags().
969
 */
970
GIOStatus
971
g_io_channel_set_flags (GIOChannel  *channel,
972
                        GIOFlags     flags,
973
                        GError     **error)
974
0
{
975
0
  g_return_val_if_fail (channel != NULL, G_IO_STATUS_ERROR);
976
0
  g_return_val_if_fail ((error == NULL) || (*error == NULL),
977
0
      G_IO_STATUS_ERROR);
978
979
0
  return (*channel->funcs->io_set_flags) (channel,
980
0
            flags & G_IO_FLAG_SET_MASK,
981
0
            error);
982
0
}
983
984
/**
985
 * g_io_channel_get_flags:
986
 * @channel: a #GIOChannel
987
 *
988
 * Gets the current flags for a #GIOChannel, including read-only
989
 * flags such as %G_IO_FLAG_IS_READABLE.
990
 *
991
 * The values of the flags %G_IO_FLAG_IS_READABLE and %G_IO_FLAG_IS_WRITABLE
992
 * are cached for internal use by the channel when it is created.
993
 * If they should change at some later point (e.g. partial shutdown
994
 * of a socket with the UNIX shutdown() function), the user
995
 * should immediately call g_io_channel_get_flags() to update
996
 * the internal values of these flags.
997
 *
998
 * Returns: the flags which are set on the channel
999
 **/
1000
GIOFlags
1001
g_io_channel_get_flags (GIOChannel *channel)
1002
0
{
1003
0
  GIOFlags flags;
1004
1005
0
  g_return_val_if_fail (channel != NULL, 0);
1006
1007
0
  flags = (* channel->funcs->io_get_flags) (channel);
1008
1009
  /* Cross implementation code */
1010
1011
0
  if (channel->is_seekable)
1012
0
    flags |= G_IO_FLAG_IS_SEEKABLE;
1013
0
  if (channel->is_readable)
1014
0
    flags |= G_IO_FLAG_IS_READABLE;
1015
0
  if (channel->is_writeable)
1016
0
    flags |= G_IO_FLAG_IS_WRITABLE;
1017
1018
0
  return flags;
1019
0
}
1020
1021
/**
1022
 * g_io_channel_set_close_on_unref:
1023
 * @channel: a #GIOChannel
1024
 * @do_close: Whether to close the channel on the final unref of
1025
 *            the GIOChannel data structure.
1026
 *
1027
 * Whether to close the channel on the final unref of the #GIOChannel
1028
 * data structure. The default value of this is %TRUE for channels
1029
 * created by g_io_channel_new_file (), and %FALSE for all other channels.
1030
 *
1031
 * Setting this flag to %TRUE for a channel you have already closed
1032
 * can cause problems when the final reference to the #GIOChannel is dropped.
1033
 **/
1034
void
1035
g_io_channel_set_close_on_unref (GIOChannel *channel,
1036
         gboolean    do_close)
1037
0
{
1038
0
  g_return_if_fail (channel != NULL);
1039
1040
0
  channel->close_on_unref = do_close;
1041
0
}
1042
1043
/**
1044
 * g_io_channel_get_close_on_unref:
1045
 * @channel: a #GIOChannel.
1046
 *
1047
 * Returns whether the file/socket/whatever associated with @channel
1048
 * will be closed when @channel receives its final unref and is
1049
 * destroyed. The default value of this is %TRUE for channels created
1050
 * by g_io_channel_new_file (), and %FALSE for all other channels.
1051
 *
1052
 * Returns: %TRUE if the channel will be closed, %FALSE otherwise.
1053
 **/
1054
gboolean
1055
g_io_channel_get_close_on_unref (GIOChannel *channel)
1056
0
{
1057
0
  g_return_val_if_fail (channel != NULL, FALSE);
1058
1059
0
  return channel->close_on_unref;
1060
0
}
1061
1062
/**
1063
 * g_io_channel_seek_position:
1064
 * @channel: a #GIOChannel
1065
 * @offset: The offset in bytes from the position specified by @type
1066
 * @type: a #GSeekType. The type %G_SEEK_CUR is only allowed in those
1067
 *                      cases where a call to g_io_channel_set_encoding ()
1068
 *                      is allowed. See the documentation for
1069
 *                      g_io_channel_set_encoding () for details.
1070
 * @error: A location to return an error of type #GIOChannelError
1071
 *
1072
 * Replacement for g_io_channel_seek() with the new API.
1073
 *
1074
 * Returns: the status of the operation.
1075
 **/
1076
/**
1077
 * GSeekType:
1078
 * @G_SEEK_CUR: the current position in the file.
1079
 * @G_SEEK_SET: the start of the file.
1080
 * @G_SEEK_END: the end of the file.
1081
 *
1082
 * An enumeration specifying the base position for a
1083
 * g_io_channel_seek_position() operation.
1084
 **/
1085
GIOStatus
1086
g_io_channel_seek_position (GIOChannel  *channel,
1087
                            gint64       offset,
1088
                            GSeekType    type,
1089
                            GError     **error)
1090
0
{
1091
0
  GIOStatus status;
1092
1093
  /* For files, only one of the read and write buffers can contain data.
1094
   * For sockets, both can contain data.
1095
   */
1096
1097
0
  g_return_val_if_fail (channel != NULL, G_IO_STATUS_ERROR);
1098
0
  g_return_val_if_fail ((error == NULL) || (*error == NULL),
1099
0
      G_IO_STATUS_ERROR);
1100
0
  g_return_val_if_fail (channel->is_seekable, G_IO_STATUS_ERROR);
1101
1102
0
  switch (type)
1103
0
    {
1104
0
      case G_SEEK_CUR: /* The user is seeking relative to the head of the buffer */
1105
0
        if (channel->use_buffer)
1106
0
          {
1107
0
            if (channel->do_encode && channel->encoded_read_buf
1108
0
                && channel->encoded_read_buf->len > 0)
1109
0
              {
1110
0
                g_warning ("Seek type G_SEEK_CUR not allowed for this"
1111
0
                  " channel's encoding.");
1112
0
                return G_IO_STATUS_ERROR;
1113
0
              }
1114
0
          if (channel->read_buf)
1115
0
            offset -= channel->read_buf->len;
1116
0
          if (channel->encoded_read_buf)
1117
0
            {
1118
0
              g_assert (channel->encoded_read_buf->len == 0 || !channel->do_encode);
1119
1120
              /* If there's anything here, it's because the encoding is UTF-8,
1121
               * so we can just subtract the buffer length, the same as for
1122
               * the unencoded data.
1123
               */
1124
1125
0
              offset -= channel->encoded_read_buf->len;
1126
0
            }
1127
0
          }
1128
0
        break;
1129
0
      case G_SEEK_SET:
1130
0
      case G_SEEK_END:
1131
0
        break;
1132
0
      default:
1133
0
        g_warning ("g_io_channel_seek_position: unknown seek type");
1134
0
        return G_IO_STATUS_ERROR;
1135
0
    }
1136
1137
0
  if (channel->use_buffer)
1138
0
    {
1139
0
      status = g_io_channel_flush (channel, error);
1140
0
      if (status != G_IO_STATUS_NORMAL)
1141
0
        return status;
1142
0
    }
1143
1144
0
  status = channel->funcs->io_seek (channel, offset, type, error);
1145
1146
0
  if ((status == G_IO_STATUS_NORMAL) && (channel->use_buffer))
1147
0
    {
1148
0
      if (channel->read_buf)
1149
0
        g_string_truncate (channel->read_buf, 0);
1150
1151
      /* Conversion state no longer matches position in file */
1152
0
      if (channel->read_cd != (GIConv) -1)
1153
0
        g_iconv (channel->read_cd, NULL, NULL, NULL, NULL);
1154
0
      if (channel->write_cd != (GIConv) -1)
1155
0
        g_iconv (channel->write_cd, NULL, NULL, NULL, NULL);
1156
1157
0
      if (channel->encoded_read_buf)
1158
0
        {
1159
0
          g_assert (channel->encoded_read_buf->len == 0 || !channel->do_encode);
1160
0
          g_string_truncate (channel->encoded_read_buf, 0);
1161
0
        }
1162
1163
0
      if (channel->partial_write_buf[0] != '\0')
1164
0
        {
1165
0
          g_warning ("Partial character at end of write buffer not flushed.");
1166
0
          channel->partial_write_buf[0] = '\0';
1167
0
        }
1168
0
    }
1169
1170
0
  return status;
1171
0
}
1172
1173
/**
1174
 * g_io_channel_flush:
1175
 * @channel: a #GIOChannel
1176
 * @error: location to store an error of type #GIOChannelError
1177
 *
1178
 * Flushes the write buffer for the GIOChannel.
1179
 *
1180
 * Returns: the status of the operation: One of
1181
 *   %G_IO_STATUS_NORMAL, %G_IO_STATUS_AGAIN, or
1182
 *   %G_IO_STATUS_ERROR.
1183
 **/
1184
GIOStatus
1185
g_io_channel_flush (GIOChannel  *channel,
1186
        GError     **error)
1187
0
{
1188
0
  GIOStatus status;
1189
0
  gsize this_time = 1, bytes_written = 0;
1190
1191
0
  g_return_val_if_fail (channel != NULL, G_IO_STATUS_ERROR);
1192
0
  g_return_val_if_fail ((error == NULL) || (*error == NULL), G_IO_STATUS_ERROR);
1193
1194
0
  if (channel->write_buf == NULL || channel->write_buf->len == 0)
1195
0
    return G_IO_STATUS_NORMAL;
1196
1197
0
  do
1198
0
    {
1199
0
      g_assert (this_time > 0);
1200
1201
0
      status = channel->funcs->io_write (channel,
1202
0
           channel->write_buf->str + bytes_written,
1203
0
           channel->write_buf->len - bytes_written,
1204
0
           &this_time, error);
1205
0
      bytes_written += this_time;
1206
0
    }
1207
0
  while ((bytes_written < channel->write_buf->len)
1208
0
         && (status == G_IO_STATUS_NORMAL));
1209
1210
0
  g_string_erase (channel->write_buf, 0, bytes_written);
1211
1212
0
  return status;
1213
0
}
1214
1215
/**
1216
 * g_io_channel_set_buffered:
1217
 * @channel: a #GIOChannel
1218
 * @buffered: whether to set the channel buffered or unbuffered
1219
 *
1220
 * The buffering state can only be set if the channel's encoding
1221
 * is %NULL. For any other encoding, the channel must be buffered.
1222
 *
1223
 * A buffered channel can only be set unbuffered if the channel's
1224
 * internal buffers have been flushed. Newly created channels or
1225
 * channels which have returned %G_IO_STATUS_EOF
1226
 * not require such a flush. For write-only channels, a call to
1227
 * g_io_channel_flush () is sufficient. For all other channels,
1228
 * the buffers may be flushed by a call to g_io_channel_seek_position ().
1229
 * This includes the possibility of seeking with seek type %G_SEEK_CUR
1230
 * and an offset of zero. Note that this means that socket-based
1231
 * channels cannot be set unbuffered once they have had data
1232
 * read from them.
1233
 *
1234
 * On unbuffered channels, it is safe to mix read and write
1235
 * calls from the new and old APIs, if this is necessary for
1236
 * maintaining old code.
1237
 *
1238
 * The default state of the channel is buffered.
1239
 **/
1240
void
1241
g_io_channel_set_buffered (GIOChannel *channel,
1242
                           gboolean    buffered)
1243
0
{
1244
0
  g_return_if_fail (channel != NULL);
1245
1246
0
  if (channel->encoding != NULL)
1247
0
    {
1248
0
      g_warning ("Need to have NULL encoding to set the buffering state of the "
1249
0
                 "channel.");
1250
0
      return;
1251
0
    }
1252
1253
0
  g_return_if_fail (!channel->read_buf || channel->read_buf->len == 0);
1254
0
  g_return_if_fail (!channel->write_buf || channel->write_buf->len == 0);
1255
1256
0
  channel->use_buffer = buffered;
1257
0
}
1258
1259
/**
1260
 * g_io_channel_get_buffered:
1261
 * @channel: a #GIOChannel
1262
 *
1263
 * Returns whether @channel is buffered.
1264
 *
1265
 * Return Value: %TRUE if the @channel is buffered. 
1266
 **/
1267
gboolean
1268
g_io_channel_get_buffered (GIOChannel *channel)
1269
0
{
1270
0
  g_return_val_if_fail (channel != NULL, FALSE);
1271
1272
0
  return channel->use_buffer;
1273
0
}
1274
1275
/**
1276
 * g_io_channel_set_encoding:
1277
 * @channel: a #GIOChannel
1278
 * @encoding: (nullable): the encoding type
1279
 * @error: location to store an error of type #GConvertError
1280
 *
1281
 * Sets the encoding for the input/output of the channel. 
1282
 * The internal encoding is always UTF-8. The default encoding 
1283
 * for the external file is UTF-8.
1284
 *
1285
 * The encoding %NULL is safe to use with binary data.
1286
 *
1287
 * The encoding can only be set if one of the following conditions
1288
 * is true:
1289
 * 
1290
 * - The channel was just created, and has not been written to or read from yet.
1291
 *
1292
 * - The channel is write-only.
1293
 *
1294
 * - The channel is a file, and the file pointer was just repositioned
1295
 *   by a call to g_io_channel_seek_position(). (This flushes all the
1296
 *   internal buffers.)
1297
 *
1298
 * - The current encoding is %NULL or UTF-8.
1299
 *
1300
 * - One of the (new API) read functions has just returned %G_IO_STATUS_EOF
1301
 *   (or, in the case of g_io_channel_read_to_end(), %G_IO_STATUS_NORMAL).
1302
 * 
1303
 * -  One of the functions g_io_channel_read_chars() or 
1304
 *    g_io_channel_read_unichar() has returned %G_IO_STATUS_AGAIN or 
1305
 *    %G_IO_STATUS_ERROR. This may be useful in the case of 
1306
 *    %G_CONVERT_ERROR_ILLEGAL_SEQUENCE.
1307
 *    Returning one of these statuses from g_io_channel_read_line(),
1308
 *    g_io_channel_read_line_string(), or g_io_channel_read_to_end()
1309
 *    does not guarantee that the encoding can be changed.
1310
 *
1311
 * Channels which do not meet one of the above conditions cannot call
1312
 * g_io_channel_seek_position() with an offset of %G_SEEK_CUR, and, if 
1313
 * they are "seekable", cannot call g_io_channel_write_chars() after 
1314
 * calling one of the API "read" functions.
1315
 *
1316
 * Return Value: %G_IO_STATUS_NORMAL if the encoding was successfully set
1317
 */
1318
GIOStatus
1319
g_io_channel_set_encoding (GIOChannel *channel,
1320
                           const gchar  *encoding,
1321
         GError      **error)
1322
0
{
1323
0
  GIConv read_cd, write_cd;
1324
0
#ifndef G_DISABLE_ASSERT
1325
0
  gboolean did_encode;
1326
0
#endif
1327
1328
0
  g_return_val_if_fail (channel != NULL, G_IO_STATUS_ERROR);
1329
0
  g_return_val_if_fail ((error == NULL) || (*error == NULL), G_IO_STATUS_ERROR);
1330
1331
  /* Make sure the encoded buffers are empty */
1332
1333
0
  g_return_val_if_fail (!channel->do_encode || !channel->encoded_read_buf ||
1334
0
      channel->encoded_read_buf->len == 0, G_IO_STATUS_ERROR);
1335
1336
0
  if (!channel->use_buffer)
1337
0
    {
1338
0
      g_warning ("Need to set the channel buffered before setting the encoding.");
1339
0
      g_warning ("Assuming this is what you meant and acting accordingly.");
1340
1341
0
      channel->use_buffer = TRUE;
1342
0
    }
1343
1344
0
  if (channel->partial_write_buf[0] != '\0')
1345
0
    {
1346
0
      g_warning ("Partial character at end of write buffer not flushed.");
1347
0
      channel->partial_write_buf[0] = '\0';
1348
0
    }
1349
1350
0
#ifndef G_DISABLE_ASSERT
1351
0
  did_encode = channel->do_encode;
1352
0
#endif
1353
1354
0
  if (!encoding || strcmp (encoding, "UTF8") == 0 || strcmp (encoding, "UTF-8") == 0)
1355
0
    {
1356
0
      channel->do_encode = FALSE;
1357
0
      read_cd = write_cd = (GIConv) -1;
1358
0
    }
1359
0
  else
1360
0
    {
1361
0
      gint err = 0;
1362
0
      const gchar *from_enc = NULL, *to_enc = NULL;
1363
1364
0
      if (channel->is_readable)
1365
0
        {
1366
0
          read_cd = g_iconv_open ("UTF-8", encoding);
1367
1368
0
          if (read_cd == (GIConv) -1)
1369
0
            {
1370
0
              err = errno;
1371
0
              from_enc = encoding;
1372
0
              to_enc = "UTF-8";
1373
0
            }
1374
0
        }
1375
0
      else
1376
0
        read_cd = (GIConv) -1;
1377
1378
0
      if (channel->is_writeable && err == 0)
1379
0
        {
1380
0
          write_cd = g_iconv_open (encoding, "UTF-8");
1381
1382
0
          if (write_cd == (GIConv) -1)
1383
0
            {
1384
0
              err = errno;
1385
0
              from_enc = "UTF-8";
1386
0
              to_enc = encoding;
1387
0
            }
1388
0
        }
1389
0
      else
1390
0
        write_cd = (GIConv) -1;
1391
1392
0
      if (err != 0)
1393
0
        {
1394
0
          g_assert (from_enc);
1395
0
          g_assert (to_enc);
1396
1397
0
          if (err == EINVAL)
1398
0
            g_set_error (error, G_CONVERT_ERROR, G_CONVERT_ERROR_NO_CONVERSION,
1399
0
                         _("Conversion from character set “%s” to “%s” is not supported"),
1400
0
                         from_enc, to_enc);
1401
0
          else
1402
0
            g_set_error (error, G_CONVERT_ERROR, G_CONVERT_ERROR_FAILED,
1403
0
                         _("Could not open converter from “%s” to “%s”: %s"),
1404
0
                         from_enc, to_enc, g_strerror (err));
1405
1406
0
          if (read_cd != (GIConv) -1)
1407
0
            g_iconv_close (read_cd);
1408
0
          if (write_cd != (GIConv) -1)
1409
0
            g_iconv_close (write_cd);
1410
1411
0
          return G_IO_STATUS_ERROR;
1412
0
        }
1413
1414
0
      channel->do_encode = TRUE;
1415
0
    }
1416
1417
  /* The encoding is ok, so set the fields in channel */
1418
1419
0
  if (channel->read_cd != (GIConv) -1)
1420
0
    g_iconv_close (channel->read_cd);
1421
0
  if (channel->write_cd != (GIConv) -1)
1422
0
    g_iconv_close (channel->write_cd);
1423
1424
0
  if (channel->encoded_read_buf && channel->encoded_read_buf->len > 0)
1425
0
    {
1426
0
      g_assert (!did_encode); /* Encoding UTF-8, NULL doesn't use encoded_read_buf */
1427
1428
      /* This is just validated UTF-8, so we can copy it back into read_buf
1429
       * so it can be encoded in whatever the new encoding is.
1430
       */
1431
1432
0
      g_string_prepend_len (channel->read_buf, channel->encoded_read_buf->str,
1433
0
                            channel->encoded_read_buf->len);
1434
0
      g_string_truncate (channel->encoded_read_buf, 0);
1435
0
    }
1436
1437
0
  channel->read_cd = read_cd;
1438
0
  channel->write_cd = write_cd;
1439
1440
0
  g_free (channel->encoding);
1441
0
  channel->encoding = g_strdup (encoding);
1442
1443
0
  return G_IO_STATUS_NORMAL;
1444
0
}
1445
1446
/**
1447
 * g_io_channel_get_encoding:
1448
 * @channel: a #GIOChannel
1449
 *
1450
 * Gets the encoding for the input/output of the channel. 
1451
 * The internal encoding is always UTF-8. The encoding %NULL 
1452
 * makes the channel safe for binary data.
1453
 *
1454
 * Returns: A string containing the encoding, this string is
1455
 *   owned by GLib and must not be freed.
1456
 **/
1457
const gchar *
1458
g_io_channel_get_encoding (GIOChannel *channel)
1459
0
{
1460
0
  g_return_val_if_fail (channel != NULL, NULL);
1461
1462
0
  return channel->encoding;
1463
0
}
1464
1465
static GIOStatus
1466
g_io_channel_fill_buffer (GIOChannel  *channel,
1467
                          GError     **err)
1468
0
{
1469
0
  gsize read_size, cur_len, oldlen;
1470
0
  GIOStatus status;
1471
1472
0
  if (channel->is_seekable && channel->write_buf && channel->write_buf->len > 0)
1473
0
    {
1474
0
      status = g_io_channel_flush (channel, err);
1475
0
      if (status != G_IO_STATUS_NORMAL)
1476
0
        return status;
1477
0
    }
1478
0
  if (channel->is_seekable && channel->partial_write_buf[0] != '\0')
1479
0
    {
1480
0
      g_warning ("Partial character at end of write buffer not flushed.");
1481
0
      channel->partial_write_buf[0] = '\0';
1482
0
    }
1483
1484
0
  if (!channel->read_buf)
1485
0
    channel->read_buf = g_string_sized_new (channel->buf_size);
1486
1487
0
  cur_len = channel->read_buf->len;
1488
1489
0
  g_string_set_size (channel->read_buf, channel->read_buf->len + channel->buf_size);
1490
1491
0
  status = channel->funcs->io_read (channel, channel->read_buf->str + cur_len,
1492
0
                                    channel->buf_size, &read_size, err);
1493
1494
0
  g_assert ((status == G_IO_STATUS_NORMAL) || (read_size == 0));
1495
1496
0
  g_string_truncate (channel->read_buf, read_size + cur_len);
1497
1498
0
  if ((status != G_IO_STATUS_NORMAL) &&
1499
0
      ((status != G_IO_STATUS_EOF) || (channel->read_buf->len == 0)))
1500
0
    return status;
1501
1502
0
  g_assert (channel->read_buf->len > 0);
1503
1504
0
  if (channel->encoded_read_buf)
1505
0
    oldlen = channel->encoded_read_buf->len;
1506
0
  else
1507
0
    {
1508
0
      oldlen = 0;
1509
0
      if (channel->encoding)
1510
0
        channel->encoded_read_buf = g_string_sized_new (channel->buf_size);
1511
0
    }
1512
1513
0
  if (channel->do_encode)
1514
0
    {
1515
0
      gsize errnum, inbytes_left, outbytes_left;
1516
0
      gchar *inbuf, *outbuf;
1517
0
      int errval;
1518
1519
0
      g_assert (channel->encoded_read_buf);
1520
1521
0
reencode:
1522
1523
0
      inbytes_left = channel->read_buf->len;
1524
0
      outbytes_left = MAX (channel->read_buf->len,
1525
0
                           channel->encoded_read_buf->allocated_len
1526
0
                           - channel->encoded_read_buf->len - 1); /* 1 for NULL */
1527
0
      outbytes_left = MAX (outbytes_left, 6);
1528
1529
0
      inbuf = channel->read_buf->str;
1530
0
      g_string_set_size (channel->encoded_read_buf,
1531
0
                         channel->encoded_read_buf->len + outbytes_left);
1532
0
      outbuf = channel->encoded_read_buf->str + channel->encoded_read_buf->len
1533
0
               - outbytes_left;
1534
1535
0
      errnum = g_iconv (channel->read_cd, &inbuf, &inbytes_left,
1536
0
      &outbuf, &outbytes_left);
1537
0
      errval = errno;
1538
1539
0
      g_assert (inbuf + inbytes_left == channel->read_buf->str
1540
0
                + channel->read_buf->len);
1541
0
      g_assert (outbuf + outbytes_left == channel->encoded_read_buf->str
1542
0
                + channel->encoded_read_buf->len);
1543
1544
0
      g_string_erase (channel->read_buf, 0,
1545
0
          channel->read_buf->len - inbytes_left);
1546
0
      g_string_truncate (channel->encoded_read_buf,
1547
0
       channel->encoded_read_buf->len - outbytes_left);
1548
1549
0
      if (errnum == (gsize) -1)
1550
0
        {
1551
0
          switch (errval)
1552
0
            {
1553
0
              case EINVAL:
1554
0
                if ((oldlen == channel->encoded_read_buf->len)
1555
0
                  && (status == G_IO_STATUS_EOF))
1556
0
                  status = G_IO_STATUS_EOF;
1557
0
                else
1558
0
                  status = G_IO_STATUS_NORMAL;
1559
0
                break;
1560
0
              case E2BIG:
1561
                /* Buffer size at least 6, wrote at least on character */
1562
0
                g_assert (inbuf != channel->read_buf->str);
1563
0
                goto reencode;
1564
0
              case EILSEQ:
1565
0
                if (oldlen < channel->encoded_read_buf->len)
1566
0
                  status = G_IO_STATUS_NORMAL;
1567
0
                else
1568
0
                  {
1569
0
                    g_set_error_literal (err, G_CONVERT_ERROR,
1570
0
                      G_CONVERT_ERROR_ILLEGAL_SEQUENCE,
1571
0
                      _("Invalid byte sequence in conversion input"));
1572
0
                    return G_IO_STATUS_ERROR;
1573
0
                  }
1574
0
                break;
1575
0
              default:
1576
0
                g_assert (errval != EBADF); /* The converter should be open */
1577
0
                g_set_error (err, G_CONVERT_ERROR, G_CONVERT_ERROR_FAILED,
1578
0
                  _("Error during conversion: %s"), g_strerror (errval));
1579
0
                return G_IO_STATUS_ERROR;
1580
0
            }
1581
0
        }
1582
0
      g_assert ((status != G_IO_STATUS_NORMAL)
1583
0
               || (channel->encoded_read_buf->len > 0));
1584
0
    }
1585
0
  else if (channel->encoding) /* UTF-8 */
1586
0
    {
1587
0
      gchar *nextchar, *lastchar;
1588
1589
0
      g_assert (channel->encoded_read_buf);
1590
1591
0
      nextchar = channel->read_buf->str;
1592
0
      lastchar = channel->read_buf->str + channel->read_buf->len;
1593
1594
0
      while (nextchar < lastchar)
1595
0
        {
1596
0
          gunichar val_char;
1597
1598
0
          val_char = g_utf8_get_char_validated (nextchar, lastchar - nextchar);
1599
1600
0
          switch (val_char)
1601
0
            {
1602
0
              case -2:
1603
                /* stop, leave partial character in buffer */
1604
0
                lastchar = nextchar;
1605
0
                break;
1606
0
              case -1:
1607
0
                if (oldlen < channel->encoded_read_buf->len)
1608
0
                  status = G_IO_STATUS_NORMAL;
1609
0
                else
1610
0
                  {
1611
0
                    g_set_error_literal (err, G_CONVERT_ERROR,
1612
0
                      G_CONVERT_ERROR_ILLEGAL_SEQUENCE,
1613
0
                      _("Invalid byte sequence in conversion input"));
1614
0
                    status = G_IO_STATUS_ERROR;
1615
0
                  }
1616
0
                lastchar = nextchar;
1617
0
                break;
1618
0
              default:
1619
0
                nextchar = g_utf8_next_char (nextchar);
1620
0
                break;
1621
0
            }
1622
0
        }
1623
1624
0
      if (lastchar > channel->read_buf->str)
1625
0
        {
1626
0
          gint copy_len = lastchar - channel->read_buf->str;
1627
1628
0
          g_string_append_len (channel->encoded_read_buf, channel->read_buf->str,
1629
0
                               copy_len);
1630
0
          g_string_erase (channel->read_buf, 0, copy_len);
1631
0
        }
1632
0
    }
1633
1634
0
  return status;
1635
0
}
1636
1637
/**
1638
 * g_io_channel_read_line:
1639
 * @channel: a #GIOChannel
1640
 * @str_return: (out): The line read from the #GIOChannel, including the
1641
 *              line terminator. This data should be freed with g_free()
1642
 *              when no longer needed. This is a nul-terminated string. 
1643
 *              If a @length of zero is returned, this will be %NULL instead.
1644
 * @length: (out) (optional): location to store length of the read data, or %NULL
1645
 * @terminator_pos: (out) (optional): location to store position of line terminator, or %NULL
1646
 * @error: A location to return an error of type #GConvertError
1647
 *         or #GIOChannelError
1648
 *
1649
 * Reads a line, including the terminating character(s),
1650
 * from a #GIOChannel into a newly-allocated string.
1651
 * @str_return will contain allocated memory if the return
1652
 * is %G_IO_STATUS_NORMAL.
1653
 *
1654
 * Returns: the status of the operation.
1655
 **/
1656
GIOStatus
1657
g_io_channel_read_line (GIOChannel  *channel,
1658
                        gchar      **str_return,
1659
                        gsize       *length,
1660
      gsize       *terminator_pos,
1661
            GError     **error)
1662
0
{
1663
0
  GIOStatus status;
1664
0
  gsize got_length;
1665
  
1666
0
  g_return_val_if_fail (channel != NULL, G_IO_STATUS_ERROR);
1667
0
  g_return_val_if_fail (str_return != NULL, G_IO_STATUS_ERROR);
1668
0
  g_return_val_if_fail ((error == NULL) || (*error == NULL),
1669
0
      G_IO_STATUS_ERROR);
1670
0
  g_return_val_if_fail (channel->is_readable, G_IO_STATUS_ERROR);
1671
1672
0
  status = g_io_channel_read_line_backend (channel, &got_length, terminator_pos, error);
1673
1674
0
  if (length && status != G_IO_STATUS_ERROR)
1675
0
    *length = got_length;
1676
1677
0
  if (status == G_IO_STATUS_NORMAL)
1678
0
    {
1679
0
      gchar *line;
1680
1681
      /* Copy the read bytes (including any embedded nuls) and nul-terminate.
1682
       * `USE_BUF (channel)->str` is guaranteed to be nul-terminated as it’s a
1683
       * #GString, so it’s safe to call g_memdup2() with +1 length to allocate
1684
       * a nul-terminator. */
1685
0
      g_assert (USE_BUF (channel));
1686
0
      line = g_memdup2 (USE_BUF (channel)->str, got_length + 1);
1687
0
      line[got_length] = '\0';
1688
0
      *str_return = g_steal_pointer (&line);
1689
0
      g_string_erase (USE_BUF (channel), 0, got_length);
1690
0
    }
1691
0
  else
1692
0
    *str_return = NULL;
1693
  
1694
0
  return status;
1695
0
}
1696
1697
/**
1698
 * g_io_channel_read_line_string:
1699
 * @channel: a #GIOChannel
1700
 * @buffer: a #GString into which the line will be written.
1701
 *          If @buffer already contains data, the old data will
1702
 *          be overwritten.
1703
 * @terminator_pos: (nullable): location to store position of line terminator, or %NULL
1704
 * @error: a location to store an error of type #GConvertError
1705
 *         or #GIOChannelError
1706
 *
1707
 * Reads a line from a #GIOChannel, using a #GString as a buffer.
1708
 *
1709
 * Returns: the status of the operation.
1710
 **/
1711
GIOStatus
1712
g_io_channel_read_line_string (GIOChannel  *channel,
1713
                               GString     *buffer,
1714
             gsize       *terminator_pos,
1715
                               GError   **error)
1716
0
{
1717
0
  gsize length;
1718
0
  GIOStatus status;
1719
1720
0
  g_return_val_if_fail (channel != NULL, G_IO_STATUS_ERROR);
1721
0
  g_return_val_if_fail (buffer != NULL, G_IO_STATUS_ERROR);
1722
0
  g_return_val_if_fail ((error == NULL) || (*error == NULL),
1723
0
      G_IO_STATUS_ERROR);
1724
0
  g_return_val_if_fail (channel->is_readable, G_IO_STATUS_ERROR);
1725
1726
0
  if (buffer->len > 0)
1727
0
    g_string_truncate (buffer, 0); /* clear out the buffer */
1728
1729
0
  status = g_io_channel_read_line_backend (channel, &length, terminator_pos, error);
1730
1731
0
  if (status == G_IO_STATUS_NORMAL)
1732
0
    {
1733
0
      g_assert (USE_BUF (channel));
1734
0
      g_string_append_len (buffer, USE_BUF (channel)->str, length);
1735
0
      g_string_erase (USE_BUF (channel), 0, length);
1736
0
    }
1737
1738
0
  return status;
1739
0
}
1740
1741
1742
static GIOStatus
1743
g_io_channel_read_line_backend (GIOChannel  *channel,
1744
                                gsize       *length,
1745
                                gsize       *terminator_pos,
1746
                                GError     **error)
1747
0
{
1748
0
  GIOStatus status;
1749
0
  gsize checked_to, line_term_len, line_length, got_term_len;
1750
0
  gboolean first_time = TRUE;
1751
1752
0
  if (!channel->use_buffer)
1753
0
    {
1754
      /* Can't do a raw read in read_line */
1755
0
      g_set_error_literal (error, G_CONVERT_ERROR, G_CONVERT_ERROR_FAILED,
1756
0
                           _("Can’t do a raw read in g_io_channel_read_line_string"));
1757
0
      return G_IO_STATUS_ERROR;
1758
0
    }
1759
1760
0
  status = G_IO_STATUS_NORMAL;
1761
1762
0
  if (channel->line_term)
1763
0
    line_term_len = channel->line_term_len;
1764
0
  else
1765
0
    line_term_len = 3;
1766
    /* This value used for setting checked_to, it's the longest of the four
1767
     * we autodetect for.
1768
     */
1769
1770
0
  checked_to = 0;
1771
1772
0
  while (TRUE)
1773
0
    {
1774
0
      gchar *nextchar, *lastchar;
1775
0
      GString *use_buf;
1776
1777
0
      if (!first_time || (BUF_LEN (USE_BUF (channel)) == 0))
1778
0
        {
1779
0
read_again:
1780
0
          status = g_io_channel_fill_buffer (channel, error);
1781
0
          switch (status)
1782
0
            {
1783
0
              case G_IO_STATUS_NORMAL:
1784
0
                if (BUF_LEN (USE_BUF (channel)) == 0)
1785
                  /* Can happen when using conversion and only read
1786
                   * part of a character
1787
                   */
1788
0
                  {
1789
0
                    first_time = FALSE;
1790
0
                    continue;
1791
0
                  }
1792
0
                break;
1793
0
              case G_IO_STATUS_EOF:
1794
0
                if (BUF_LEN (USE_BUF (channel)) == 0)
1795
0
                  {
1796
0
                    if (length)
1797
0
                      *length = 0;
1798
1799
0
                    if (channel->encoding && channel->read_buf->len != 0)
1800
0
                      {
1801
0
                        g_set_error_literal (error, G_CONVERT_ERROR,
1802
0
                                             G_CONVERT_ERROR_PARTIAL_INPUT,
1803
0
                                             _("Leftover unconverted data in "
1804
0
                                               "read buffer"));
1805
0
                        return G_IO_STATUS_ERROR;
1806
0
                      }
1807
0
                    else
1808
0
                      return G_IO_STATUS_EOF;
1809
0
                  }
1810
0
                break;
1811
0
              default:
1812
0
                if (length)
1813
0
                  *length = 0;
1814
0
                return status;
1815
0
            }
1816
0
        }
1817
1818
0
      g_assert (BUF_LEN (USE_BUF (channel)) != 0);
1819
1820
0
      use_buf = USE_BUF (channel); /* The buffer has been created by this point */
1821
1822
0
      first_time = FALSE;
1823
1824
0
      lastchar = use_buf->str + use_buf->len;
1825
1826
0
      for (nextchar = use_buf->str + checked_to; nextchar < lastchar;
1827
0
           channel->encoding ? nextchar = g_utf8_next_char (nextchar) : nextchar++)
1828
0
        {
1829
0
          if (channel->line_term)
1830
0
            {
1831
0
              if ((size_t) (lastchar - nextchar) >= line_term_len &&
1832
0
                  memcmp (channel->line_term, nextchar, line_term_len) == 0)
1833
0
                {
1834
0
                  line_length = nextchar - use_buf->str;
1835
0
                  got_term_len = line_term_len;
1836
0
                  goto done;
1837
0
                }
1838
0
            }
1839
0
          else /* auto detect */
1840
0
            {
1841
0
              switch (*nextchar)
1842
0
                {
1843
0
                  case '\n': /* unix */
1844
0
                    line_length = nextchar - use_buf->str;
1845
0
                    got_term_len = 1;
1846
0
                    goto done;
1847
0
                  case '\r': /* Warning: do not use with sockets */
1848
0
                    line_length = nextchar - use_buf->str;
1849
0
                    if ((nextchar == lastchar - 1) && (status != G_IO_STATUS_EOF)
1850
0
                       && (lastchar == use_buf->str + use_buf->len))
1851
0
                      goto read_again; /* Try to read more data */
1852
0
                    if ((nextchar < lastchar - 1) && (*(nextchar + 1) == '\n')) /* dos */
1853
0
                      got_term_len = 2;
1854
0
                    else /* mac */
1855
0
                      got_term_len = 1;
1856
0
                    goto done;
1857
0
                  case '\xe2': /* Unicode paragraph separator */
1858
0
                    if (strncmp ("\xe2\x80\xa9", nextchar, 3) == 0)
1859
0
                      {
1860
0
                        line_length = nextchar - use_buf->str;
1861
0
                        got_term_len = 3;
1862
0
                        goto done;
1863
0
                      }
1864
0
                    break;
1865
0
                  case '\0': /* Embedded null in input */
1866
0
                    line_length = nextchar - use_buf->str;
1867
0
                    got_term_len = 1;
1868
0
                    goto done;
1869
0
                  default: /* no match */
1870
0
                    break;
1871
0
                }
1872
0
            }
1873
0
        }
1874
1875
      /* If encoding != NULL, valid UTF-8, didn't overshoot */
1876
0
      g_assert (nextchar == lastchar);
1877
1878
      /* Check for EOF */
1879
1880
0
      if (status == G_IO_STATUS_EOF)
1881
0
        {
1882
0
          if (channel->encoding && channel->read_buf->len > 0)
1883
0
            {
1884
0
              g_set_error_literal (error, G_CONVERT_ERROR, G_CONVERT_ERROR_PARTIAL_INPUT,
1885
0
                                   _("Channel terminates in a partial character"));
1886
0
              return G_IO_STATUS_ERROR;
1887
0
            }
1888
0
          line_length = use_buf->len;
1889
0
          got_term_len = 0;
1890
0
          break;
1891
0
        }
1892
1893
0
      if (use_buf->len > line_term_len - 1)
1894
0
  checked_to = use_buf->len - (line_term_len - 1);
1895
0
      else
1896
0
  checked_to = 0;
1897
0
    }
1898
1899
0
done:
1900
1901
0
  if (terminator_pos)
1902
0
    *terminator_pos = line_length;
1903
1904
0
  if (length)
1905
0
    *length = line_length + got_term_len;
1906
1907
0
  return G_IO_STATUS_NORMAL;
1908
0
}
1909
1910
/**
1911
 * g_io_channel_read_to_end:
1912
 * @channel: a #GIOChannel
1913
 * @str_return:  (out) (array length=length) (element-type guint8): Location to
1914
 *              store a pointer to a string holding the remaining data in the
1915
 *              #GIOChannel. This data should be freed with g_free() when no
1916
 *              longer needed. This data is terminated by an extra nul
1917
 *              character, but there may be other nuls in the intervening data.
1918
 * @length: (out): location to store length of the data
1919
 * @error: location to return an error of type #GConvertError
1920
 *         or #GIOChannelError
1921
 *
1922
 * Reads all the remaining data from the file.
1923
 *
1924
 * Returns: %G_IO_STATUS_NORMAL on success. 
1925
 *     This function never returns %G_IO_STATUS_EOF.
1926
 **/
1927
GIOStatus
1928
g_io_channel_read_to_end (GIOChannel  *channel,
1929
                          gchar      **str_return,
1930
                          gsize       *length,
1931
                          GError     **error)
1932
0
{
1933
0
  GIOStatus status;
1934
    
1935
0
  g_return_val_if_fail (channel != NULL, G_IO_STATUS_ERROR);
1936
0
  g_return_val_if_fail ((error == NULL) || (*error == NULL),
1937
0
    G_IO_STATUS_ERROR);
1938
0
  g_return_val_if_fail (channel->is_readable, G_IO_STATUS_ERROR);
1939
1940
0
  if (str_return)
1941
0
    *str_return = NULL;
1942
0
  if (length)
1943
0
    *length = 0;
1944
1945
0
  if (!channel->use_buffer)
1946
0
    {
1947
0
      g_set_error_literal (error, G_CONVERT_ERROR, G_CONVERT_ERROR_FAILED,
1948
0
                           _("Can’t do a raw read in g_io_channel_read_to_end"));
1949
0
      return G_IO_STATUS_ERROR;
1950
0
    }
1951
1952
0
  do
1953
0
    status = g_io_channel_fill_buffer (channel, error);
1954
0
  while (status == G_IO_STATUS_NORMAL);
1955
1956
0
  if (status != G_IO_STATUS_EOF)
1957
0
    return status;
1958
1959
0
  if (channel->encoding && channel->read_buf->len > 0)
1960
0
    {
1961
0
      g_set_error_literal (error, G_CONVERT_ERROR, G_CONVERT_ERROR_PARTIAL_INPUT,
1962
0
                           _("Channel terminates in a partial character"));
1963
0
      return G_IO_STATUS_ERROR;
1964
0
    }
1965
1966
0
  if (USE_BUF (channel) == NULL)
1967
0
    {
1968
      /* length is already set to zero */
1969
0
      if (str_return)
1970
0
        *str_return = g_strdup ("");
1971
0
    }
1972
0
  else
1973
0
    {
1974
0
      if (length)
1975
0
        *length = USE_BUF (channel)->len;
1976
1977
0
      if (str_return)
1978
0
        *str_return = g_string_free (USE_BUF (channel), FALSE);
1979
0
      else
1980
0
        g_string_free (USE_BUF (channel), TRUE);
1981
1982
0
      if (channel->encoding)
1983
0
  channel->encoded_read_buf = NULL;
1984
0
      else
1985
0
  channel->read_buf = NULL;
1986
0
    }
1987
1988
0
  return G_IO_STATUS_NORMAL;
1989
0
}
1990
1991
/**
1992
 * g_io_channel_read_chars:
1993
 * @channel: a #GIOChannel
1994
 * @buf: (out caller-allocates) (array length=count) (element-type guint8):
1995
 *     a buffer to read data into
1996
 * @count: (in): the size of the buffer. Note that the buffer may not be
1997
 *     completely filled even if there is data in the buffer if the
1998
 *     remaining data is not a complete character.
1999
 * @bytes_read: (out) (optional): The number of bytes read. This may be
2000
 *     zero even on success if count < 6 and the channel's encoding
2001
 *     is non-%NULL. This indicates that the next UTF-8 character is
2002
 *     too wide for the buffer.
2003
 * @error: a location to return an error of type #GConvertError
2004
 *     or #GIOChannelError.
2005
 *
2006
 * Replacement for g_io_channel_read() with the new API.
2007
 *
2008
 * Returns: the status of the operation.
2009
 */
2010
GIOStatus
2011
g_io_channel_read_chars (GIOChannel  *channel,
2012
                         gchar       *buf,
2013
                         gsize        count,
2014
                         gsize       *bytes_read,
2015
                         GError     **error)
2016
0
{
2017
0
  GIOStatus status;
2018
0
  gsize got_bytes;
2019
2020
0
  g_return_val_if_fail (channel != NULL, G_IO_STATUS_ERROR);
2021
0
  g_return_val_if_fail ((error == NULL) || (*error == NULL), G_IO_STATUS_ERROR);
2022
0
  g_return_val_if_fail (channel->is_readable, G_IO_STATUS_ERROR);
2023
2024
0
  if (count == 0)
2025
0
    {
2026
0
      if (bytes_read)
2027
0
        *bytes_read = 0;
2028
0
      return G_IO_STATUS_NORMAL;
2029
0
    }
2030
0
  g_return_val_if_fail (buf != NULL, G_IO_STATUS_ERROR);
2031
2032
0
  if (!channel->use_buffer)
2033
0
    {
2034
0
      gsize tmp_bytes;
2035
2036
0
      g_assert (!channel->read_buf || channel->read_buf->len == 0);
2037
2038
0
      status = channel->funcs->io_read (channel, buf, count, &tmp_bytes, error);
2039
2040
0
      if (bytes_read)
2041
0
        *bytes_read = tmp_bytes;
2042
2043
0
      return status;
2044
0
    }
2045
2046
0
  status = G_IO_STATUS_NORMAL;
2047
2048
0
  while (BUF_LEN (USE_BUF (channel)) < count && status == G_IO_STATUS_NORMAL)
2049
0
    status = g_io_channel_fill_buffer (channel, error);
2050
2051
  /* Only return an error if we have no data */
2052
2053
0
  if (BUF_LEN (USE_BUF (channel)) == 0)
2054
0
    {
2055
0
      g_assert (status != G_IO_STATUS_NORMAL);
2056
2057
0
      if (status == G_IO_STATUS_EOF && channel->encoding
2058
0
          && BUF_LEN (channel->read_buf) > 0)
2059
0
        {
2060
0
          g_set_error_literal (error, G_CONVERT_ERROR,
2061
0
                               G_CONVERT_ERROR_PARTIAL_INPUT,
2062
0
                               _("Leftover unconverted data in read buffer"));
2063
0
          status = G_IO_STATUS_ERROR;
2064
0
        }
2065
2066
0
      if (bytes_read)
2067
0
        *bytes_read = 0;
2068
2069
0
      return status;
2070
0
    }
2071
2072
0
  if (status == G_IO_STATUS_ERROR)
2073
0
    g_clear_error (error);
2074
2075
0
  got_bytes = MIN (count, BUF_LEN (USE_BUF (channel)));
2076
2077
0
  g_assert (got_bytes > 0);
2078
2079
0
  if (channel->encoding)
2080
    /* Don't validate for NULL encoding, binary safe */
2081
0
    {
2082
0
      gchar *nextchar, *prevchar;
2083
2084
0
      g_assert (USE_BUF (channel) == channel->encoded_read_buf);
2085
2086
0
      nextchar = channel->encoded_read_buf->str;
2087
2088
0
      do
2089
0
        {
2090
0
          prevchar = nextchar;
2091
0
          nextchar = g_utf8_next_char (nextchar);
2092
0
          g_assert (nextchar != prevchar); /* Possible for *prevchar of -1 or -2 */
2093
0
        }
2094
0
      while (nextchar < channel->encoded_read_buf->str + got_bytes);
2095
2096
0
      if (nextchar > channel->encoded_read_buf->str + got_bytes)
2097
0
        got_bytes = prevchar - channel->encoded_read_buf->str;
2098
2099
0
      g_assert (got_bytes > 0 || count < 6);
2100
0
    }
2101
2102
0
  memcpy (buf, USE_BUF (channel)->str, got_bytes);
2103
0
  g_string_erase (USE_BUF (channel), 0, got_bytes);
2104
2105
0
  if (bytes_read)
2106
0
    *bytes_read = got_bytes;
2107
2108
0
  return G_IO_STATUS_NORMAL;
2109
0
}
2110
2111
/**
2112
 * g_io_channel_read_unichar:
2113
 * @channel: a #GIOChannel
2114
 * @thechar: (out): a location to return a character
2115
 * @error: a location to return an error of type #GConvertError
2116
 *         or #GIOChannelError
2117
 *
2118
 * Reads a Unicode character from @channel.
2119
 * This function cannot be called on a channel with %NULL encoding.
2120
 *
2121
 * Returns: a #GIOStatus
2122
 **/
2123
GIOStatus
2124
g_io_channel_read_unichar (GIOChannel  *channel,
2125
         gunichar    *thechar,
2126
         GError     **error)
2127
0
{
2128
0
  GIOStatus status = G_IO_STATUS_NORMAL;
2129
2130
0
  g_return_val_if_fail (channel != NULL, G_IO_STATUS_ERROR);
2131
0
  g_return_val_if_fail (channel->encoding != NULL, G_IO_STATUS_ERROR);
2132
0
  g_return_val_if_fail ((error == NULL) || (*error == NULL),
2133
0
      G_IO_STATUS_ERROR);
2134
0
  g_return_val_if_fail (channel->is_readable, G_IO_STATUS_ERROR);
2135
2136
0
  while (BUF_LEN (channel->encoded_read_buf) == 0 && status == G_IO_STATUS_NORMAL)
2137
0
    status = g_io_channel_fill_buffer (channel, error);
2138
2139
  /* Only return an error if we have no data */
2140
2141
0
  if (BUF_LEN (USE_BUF (channel)) == 0)
2142
0
    {
2143
0
      g_assert (status != G_IO_STATUS_NORMAL);
2144
2145
0
      if (status == G_IO_STATUS_EOF && BUF_LEN (channel->read_buf) > 0)
2146
0
        {
2147
0
          g_set_error_literal (error, G_CONVERT_ERROR,
2148
0
                               G_CONVERT_ERROR_PARTIAL_INPUT,
2149
0
                               _("Leftover unconverted data in read buffer"));
2150
0
          status = G_IO_STATUS_ERROR;
2151
0
        }
2152
2153
0
      if (thechar)
2154
0
        *thechar = (gunichar) -1;
2155
2156
0
      return status;
2157
0
    }
2158
2159
0
  if (status == G_IO_STATUS_ERROR)
2160
0
    g_clear_error (error);
2161
2162
0
  if (thechar)
2163
0
    *thechar = g_utf8_get_char (channel->encoded_read_buf->str);
2164
2165
0
  g_string_erase (channel->encoded_read_buf, 0,
2166
0
                  g_utf8_next_char (channel->encoded_read_buf->str)
2167
0
                  - channel->encoded_read_buf->str);
2168
2169
0
  return G_IO_STATUS_NORMAL;
2170
0
}
2171
2172
/**
2173
 * g_io_channel_write_chars:
2174
 * @channel: a #GIOChannel
2175
 * @buf: (array) (element-type guint8): a buffer to write data from
2176
 * @count: the size of the buffer. If -1, the buffer
2177
 *         is taken to be a nul-terminated string.
2178
 * @bytes_written: (out): The number of bytes written. This can be nonzero
2179
 *                 even if the return value is not %G_IO_STATUS_NORMAL.
2180
 *                 If the return value is %G_IO_STATUS_NORMAL and the
2181
 *                 channel is blocking, this will always be equal
2182
 *                 to @count if @count >= 0.
2183
 * @error: a location to return an error of type #GConvertError
2184
 *         or #GIOChannelError
2185
 *
2186
 * Replacement for g_io_channel_write() with the new API.
2187
 *
2188
 * On seekable channels with encodings other than %NULL or UTF-8, generic
2189
 * mixing of reading and writing is not allowed. A call to g_io_channel_write_chars ()
2190
 * may only be made on a channel from which data has been read in the
2191
 * cases described in the documentation for g_io_channel_set_encoding ().
2192
 *
2193
 * Returns: the status of the operation.
2194
 **/
2195
GIOStatus
2196
g_io_channel_write_chars (GIOChannel   *channel,
2197
                          const gchar  *buf,
2198
                          gssize        count,
2199
        gsize        *bytes_written,
2200
                          GError      **error)
2201
0
{
2202
0
  gsize count_unsigned;
2203
0
  GIOStatus status;
2204
0
  gsize wrote_bytes = 0;
2205
2206
0
  g_return_val_if_fail (channel != NULL, G_IO_STATUS_ERROR);
2207
0
  g_return_val_if_fail (buf != NULL || count == 0, G_IO_STATUS_ERROR);
2208
0
  g_return_val_if_fail ((error == NULL) || (*error == NULL),
2209
0
      G_IO_STATUS_ERROR);
2210
0
  g_return_val_if_fail (channel->is_writeable, G_IO_STATUS_ERROR);
2211
2212
0
  if (count < 0)
2213
0
    count_unsigned = strlen (buf);
2214
0
  else
2215
0
    count_unsigned = count;
2216
2217
0
  if (count_unsigned == 0)
2218
0
    {
2219
0
      if (bytes_written)
2220
0
        *bytes_written = 0;
2221
0
      return G_IO_STATUS_NORMAL;
2222
0
    }
2223
2224
0
  g_assert (count_unsigned > 0);
2225
2226
  /* Raw write case */
2227
2228
0
  if (!channel->use_buffer)
2229
0
    {
2230
0
      gsize tmp_bytes;
2231
      
2232
0
      g_assert (!channel->write_buf || channel->write_buf->len == 0);
2233
0
      g_assert (channel->partial_write_buf[0] == '\0');
2234
      
2235
0
      status = channel->funcs->io_write (channel, buf, count_unsigned,
2236
0
                                         &tmp_bytes, error);
2237
2238
0
      if (bytes_written)
2239
0
  *bytes_written = tmp_bytes;
2240
2241
0
      return status;
2242
0
    }
2243
2244
  /* General case */
2245
2246
0
  if (channel->is_seekable && (( BUF_LEN (channel->read_buf) > 0)
2247
0
    || (BUF_LEN (channel->encoded_read_buf) > 0)))
2248
0
    {
2249
0
      if (channel->do_encode && BUF_LEN (channel->encoded_read_buf) > 0)
2250
0
        {
2251
0
          g_warning ("Mixed reading and writing not allowed on encoded files");
2252
0
          return G_IO_STATUS_ERROR;
2253
0
        }
2254
0
      status = g_io_channel_seek_position (channel, 0, G_SEEK_CUR, error);
2255
0
      if (status != G_IO_STATUS_NORMAL)
2256
0
        {
2257
0
          if (bytes_written)
2258
0
            *bytes_written = 0;
2259
0
          return status;
2260
0
        }
2261
0
    }
2262
2263
0
  if (!channel->write_buf)
2264
0
    channel->write_buf = g_string_sized_new (channel->buf_size);
2265
2266
0
  while (wrote_bytes < count_unsigned)
2267
0
    {
2268
0
      gsize space_in_buf;
2269
2270
      /* If the buffer is full, try a write immediately. In
2271
       * the nonblocking case, this prevents the user from
2272
       * writing just a little bit to the buffer every time
2273
       * and never receiving an EAGAIN.
2274
       */
2275
2276
0
      if (channel->write_buf->len >= channel->buf_size - MAX_CHAR_SIZE)
2277
0
        {
2278
0
          gsize did_write = 0, this_time;
2279
2280
0
          do
2281
0
            {
2282
0
              status = channel->funcs->io_write (channel, channel->write_buf->str
2283
0
                                                 + did_write, channel->write_buf->len
2284
0
                                                 - did_write, &this_time, error);
2285
0
              did_write += this_time;
2286
0
            }
2287
0
          while (status == G_IO_STATUS_NORMAL &&
2288
0
                 did_write < MIN (channel->write_buf->len, MAX_CHAR_SIZE));
2289
2290
0
          g_string_erase (channel->write_buf, 0, did_write);
2291
2292
0
          if (status != G_IO_STATUS_NORMAL)
2293
0
            {
2294
0
              if (status == G_IO_STATUS_AGAIN && wrote_bytes > 0)
2295
0
                status = G_IO_STATUS_NORMAL;
2296
0
              if (bytes_written)
2297
0
                *bytes_written = wrote_bytes;
2298
0
              return status;
2299
0
            }
2300
0
        }
2301
2302
0
      space_in_buf = MAX (channel->buf_size, channel->write_buf->allocated_len - 1)
2303
0
                     - channel->write_buf->len; /* 1 for NULL */
2304
2305
      /* This is only true because g_io_channel_set_buffer_size ()
2306
       * ensures that channel->buf_size >= MAX_CHAR_SIZE.
2307
       */
2308
0
      g_assert (space_in_buf >= MAX_CHAR_SIZE);
2309
2310
0
      if (!channel->encoding)
2311
0
        {
2312
0
          gsize write_this = MIN (space_in_buf, count_unsigned - wrote_bytes);
2313
2314
          /* g_string_append_len() takes a gssize, so don’t overflow it*/
2315
0
          if (write_this > G_MAXSSIZE)
2316
0
            write_this = G_MAXSSIZE;
2317
2318
0
          g_string_append_len (channel->write_buf, buf, write_this);
2319
0
          buf += write_this;
2320
0
          wrote_bytes += write_this;
2321
0
        }
2322
0
      else
2323
0
        {
2324
0
          const gchar *from_buf;
2325
0
          gsize from_buf_len, from_buf_old_len, left_len;
2326
0
          gsize err;
2327
0
          gint errnum;
2328
2329
0
          if (channel->partial_write_buf[0] != '\0')
2330
0
            {
2331
0
              g_assert (wrote_bytes == 0);
2332
2333
0
              from_buf = channel->partial_write_buf;
2334
0
              from_buf_old_len = strlen (channel->partial_write_buf);
2335
0
              g_assert (from_buf_old_len > 0);
2336
0
              from_buf_len = MIN (6, from_buf_old_len + count_unsigned);
2337
2338
0
              memcpy (channel->partial_write_buf + from_buf_old_len, buf,
2339
0
                      from_buf_len - from_buf_old_len);
2340
0
            }
2341
0
          else
2342
0
            {
2343
0
              from_buf = buf;
2344
0
              from_buf_len = count_unsigned - wrote_bytes;
2345
0
              from_buf_old_len = 0;
2346
0
            }
2347
2348
0
reconvert:
2349
2350
0
          if (!channel->do_encode) /* UTF-8 encoding */
2351
0
            {
2352
0
              const gchar *badchar;
2353
0
              gsize try_len = MIN (from_buf_len, space_in_buf);
2354
2355
              /* UTF-8, just validate, emulate g_iconv */
2356
2357
0
              if (!g_utf8_validate_len (from_buf, try_len, &badchar))
2358
0
                {
2359
0
                  gunichar try_char;
2360
0
                  gsize incomplete_len = from_buf + try_len - badchar;
2361
2362
0
                  left_len = from_buf + from_buf_len - badchar;
2363
2364
0
                  try_char = g_utf8_get_char_validated (badchar, incomplete_len);
2365
2366
0
                  switch (try_char)
2367
0
                    {
2368
0
                      case -2:
2369
0
                        g_assert (incomplete_len < 6);
2370
0
                        if (try_len == from_buf_len)
2371
0
                          {
2372
0
                            errnum = EINVAL;
2373
0
                            err = (gsize) -1;
2374
0
                          }
2375
0
                        else
2376
0
                          {
2377
0
                            errnum = 0;
2378
0
                            err = (gsize) 0;
2379
0
                          }
2380
0
                        break;
2381
0
                      case -1:
2382
0
                        g_warning ("Invalid UTF-8 passed to g_io_channel_write_chars().");
2383
                        /* FIXME bail here? */
2384
0
                        errnum = EILSEQ;
2385
0
                        err = (gsize) -1;
2386
0
                        break;
2387
0
                      default:
2388
0
                        g_assert_not_reached ();
2389
0
                        err = (gsize) -1;
2390
0
                        errnum = 0; /* Don't confuse the compiler */
2391
0
                    }
2392
0
                }
2393
0
              else
2394
0
                {
2395
0
                  err = (gsize) 0;
2396
0
                  errnum = 0;
2397
0
                  left_len = from_buf_len - try_len;
2398
0
                }
2399
2400
0
              g_string_append_len (channel->write_buf, from_buf,
2401
0
                                   from_buf_len - left_len);
2402
0
              from_buf += from_buf_len - left_len;
2403
0
            }
2404
0
          else
2405
0
            {
2406
0
               gchar *outbuf;
2407
2408
0
               left_len = from_buf_len;
2409
0
               g_string_set_size (channel->write_buf, channel->write_buf->len
2410
0
                                  + space_in_buf);
2411
0
               outbuf = channel->write_buf->str + channel->write_buf->len
2412
0
                        - space_in_buf;
2413
0
               err = g_iconv (channel->write_cd, (gchar **) &from_buf, &left_len,
2414
0
                              &outbuf, &space_in_buf);
2415
0
               errnum = errno;
2416
0
               g_string_truncate (channel->write_buf, channel->write_buf->len
2417
0
                                  - space_in_buf);
2418
0
            }
2419
2420
0
          if (err == (gsize) -1)
2421
0
            {
2422
0
              switch (errnum)
2423
0
          {
2424
0
                  case EINVAL:
2425
0
                    g_assert (left_len < 6);
2426
2427
0
                    if (from_buf_old_len == 0)
2428
0
                      {
2429
                        /* Not from partial_write_buf */
2430
2431
0
                        memcpy (channel->partial_write_buf, from_buf, left_len);
2432
0
                        channel->partial_write_buf[left_len] = '\0';
2433
0
                        if (bytes_written)
2434
0
                          *bytes_written = count_unsigned;
2435
0
                        return G_IO_STATUS_NORMAL;
2436
0
                      }
2437
2438
                    /* Working in partial_write_buf */
2439
2440
0
                    if (left_len == from_buf_len)
2441
0
                      {
2442
                        /* Didn't convert anything, must still have
2443
                         * less than a full character
2444
                         */
2445
2446
0
                        g_assert (count_unsigned == from_buf_len - from_buf_old_len);
2447
2448
0
                        channel->partial_write_buf[from_buf_len] = '\0';
2449
2450
0
                        if (bytes_written)
2451
0
                          *bytes_written = count_unsigned;
2452
2453
0
                        return G_IO_STATUS_NORMAL;
2454
0
                      }
2455
2456
0
                    g_assert (from_buf_len - left_len >= from_buf_old_len);
2457
2458
                    /* We converted all the old data. This is fine */
2459
2460
0
                    break;
2461
0
                  case E2BIG:
2462
0
                    if (from_buf_len == left_len)
2463
0
                      {
2464
                        /* Nothing was written, add enough space for
2465
                         * at least one character.
2466
                         */
2467
0
                        space_in_buf += MAX_CHAR_SIZE;
2468
0
                        goto reconvert;
2469
0
                      }
2470
0
                    break;
2471
0
                  case EILSEQ:
2472
0
                    g_set_error_literal (error, G_CONVERT_ERROR,
2473
0
                      G_CONVERT_ERROR_ILLEGAL_SEQUENCE,
2474
0
                      _("Invalid byte sequence in conversion input"));
2475
0
                    if (from_buf_old_len > 0 && from_buf_len == left_len)
2476
0
                      g_warning ("Illegal sequence due to partial character "
2477
0
                                 "at the end of a previous write.");
2478
0
                    else
2479
0
                      {
2480
0
                        g_assert (from_buf_len >= left_len + from_buf_old_len);
2481
0
                        wrote_bytes += from_buf_len - left_len - from_buf_old_len;
2482
0
                      }
2483
0
                    if (bytes_written)
2484
0
                      *bytes_written = wrote_bytes;
2485
0
                    channel->partial_write_buf[0] = '\0';
2486
0
                    return G_IO_STATUS_ERROR;
2487
0
                  default:
2488
0
                    g_set_error (error, G_CONVERT_ERROR, G_CONVERT_ERROR_FAILED,
2489
0
                      _("Error during conversion: %s"), g_strerror (errnum));
2490
0
                    if (from_buf_len >= left_len + from_buf_old_len)
2491
0
                      wrote_bytes += from_buf_len - left_len - from_buf_old_len;
2492
0
                    if (bytes_written)
2493
0
                      *bytes_written = wrote_bytes;
2494
0
                    channel->partial_write_buf[0] = '\0';
2495
0
                    return G_IO_STATUS_ERROR;
2496
0
                }
2497
0
            }
2498
2499
0
          g_assert (from_buf_len - left_len >= from_buf_old_len);
2500
2501
0
          wrote_bytes += from_buf_len - left_len - from_buf_old_len;
2502
2503
0
          if (from_buf_old_len > 0)
2504
0
            {
2505
              /* We were working in partial_write_buf */
2506
2507
0
              buf += from_buf_len - left_len - from_buf_old_len;
2508
0
              channel->partial_write_buf[0] = '\0';
2509
0
            }
2510
0
          else
2511
0
            buf = from_buf;
2512
0
        }
2513
0
    }
2514
2515
0
  if (bytes_written)
2516
0
    *bytes_written = count_unsigned;
2517
2518
0
  return G_IO_STATUS_NORMAL;
2519
0
}
2520
2521
/**
2522
 * g_io_channel_write_unichar:
2523
 * @channel: a #GIOChannel
2524
 * @thechar: a character
2525
 * @error: location to return an error of type #GConvertError
2526
 *         or #GIOChannelError
2527
 *
2528
 * Writes a Unicode character to @channel.
2529
 * This function cannot be called on a channel with %NULL encoding.
2530
 *
2531
 * Returns: a #GIOStatus
2532
 **/
2533
GIOStatus
2534
g_io_channel_write_unichar (GIOChannel  *channel,
2535
          gunichar     thechar,
2536
          GError     **error)
2537
0
{
2538
0
  GIOStatus status;
2539
0
  gchar static_buf[6];
2540
0
  gsize char_len, wrote_len;
2541
2542
0
  g_return_val_if_fail (channel != NULL, G_IO_STATUS_ERROR);
2543
0
  g_return_val_if_fail (channel->encoding != NULL, G_IO_STATUS_ERROR);
2544
0
  g_return_val_if_fail ((error == NULL) || (*error == NULL),
2545
0
      G_IO_STATUS_ERROR);
2546
0
  g_return_val_if_fail (channel->is_writeable, G_IO_STATUS_ERROR);
2547
2548
0
  char_len = g_unichar_to_utf8 (thechar, static_buf);
2549
2550
0
  if (channel->partial_write_buf[0] != '\0')
2551
0
    {
2552
0
      g_warning ("Partial character written before writing unichar.");
2553
0
      channel->partial_write_buf[0] = '\0';
2554
0
    }
2555
2556
0
  status = g_io_channel_write_chars (channel, static_buf,
2557
0
                                     char_len, &wrote_len, error);
2558
2559
  /* We validate UTF-8, so we can't get a partial write */
2560
2561
0
  g_assert (wrote_len == char_len || status != G_IO_STATUS_NORMAL);
2562
2563
0
  return status;
2564
0
}
2565
2566
/**
2567
 * G_IO_CHANNEL_ERROR:
2568
 *
2569
 * Error domain for #GIOChannel operations. Errors in this domain will
2570
 * be from the #GIOChannelError enumeration. See #GError for
2571
 * information on error domains.
2572
 **/
2573
/**
2574
 * GIOChannelError:
2575
 * @G_IO_CHANNEL_ERROR_FBIG: File too large.
2576
 * @G_IO_CHANNEL_ERROR_INVAL: Invalid argument.
2577
 * @G_IO_CHANNEL_ERROR_IO: IO error.
2578
 * @G_IO_CHANNEL_ERROR_ISDIR: File is a directory.
2579
 * @G_IO_CHANNEL_ERROR_NOSPC: No space left on device.
2580
 * @G_IO_CHANNEL_ERROR_NXIO: No such device or address.
2581
 * @G_IO_CHANNEL_ERROR_OVERFLOW: Value too large for defined datatype.
2582
 * @G_IO_CHANNEL_ERROR_PIPE: Broken pipe.
2583
 * @G_IO_CHANNEL_ERROR_FAILED: Some other error.
2584
 *
2585
 * Error codes returned by #GIOChannel operations.
2586
 **/
2587
2588
G_DEFINE_QUARK (g-io-channel-error-quark, g_io_channel_error)