aboutsummaryrefslogtreecommitdiffstats
path: root/camel/camel-stream.c
blob: 2c0a85f5ff1cc2a0c876b425a2e2c8f1543c6bf7 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
/* -*- Mode: C; tab-width: 8; indent-tabs-mode: t; c-basic-offset: 8 -*- */
/* camel-stream.c : abstract class for a stream */


/* 
 *
 * Copyright (C) 1999 Bertrand Guiheneuf <Bertrand.Guiheneuf@inria.fr> .
 *
 * This program is free software; you can redistribute it and/or 
 * modify it under the terms of the GNU General Public License as 
 * published by the Free Software Foundation; either version 2 of the
 * License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
 * USA
 */
#include <config.h>
#include "camel-stream.h"

static GtkObjectClass *parent_class = NULL;


/* Returns the class for a CamelMimeMessage */
#define CS_CLASS(so) CAMEL_STREAM_CLASS (GTK_OBJECT(so)->klass)

static void
default_camel_flush (CamelStream *stream)
{
    /* nothing */
}

static void
default_camel_close (CamelStream *stream)
{
    /* nothing */
}

static gint
default_camel_seek (CamelStream *stream, gint offset, CamelStreamSeekPolicy policy)
{
    /* nothing */
}

static void
camel_stream_class_init (CamelStreamClass *camel_stream_class)
{

    parent_class = gtk_type_class (gtk_object_get_type ());

    /* virtual method definition */
    camel_stream_class->read = NULL;
    camel_stream_class->write = NULL;
    camel_stream_class->flush = default_camel_flush;
    camel_stream_class->available = NULL;
    camel_stream_class->eos = NULL; 
    camel_stream_class->close = default_camel_close;
    camel_stream_class->seek = default_camel_seek;

    /* virtual method overload */
}

GtkType
camel_stream_get_type (void)
{
    static GtkType camel_stream_type = 0;
    
    if (!camel_stream_type) {
        GtkTypeInfo camel_stream_info = 
        {
            "CamelStream",
            sizeof (CamelStream),
            sizeof (CamelStreamClass),
            (GtkClassInitFunc) camel_stream_class_init,
            (GtkObjectInitFunc) NULL,
                /* reserved_1 */ NULL,
                /* reserved_2 */ NULL,
            (GtkClassInitFunc) NULL,
        };
        
        camel_stream_type = gtk_type_unique (gtk_object_get_type (), &camel_stream_info);
    }
    
    return camel_stream_type;
}

/**
 * camel_stream_read: 
 * @stream: a CamelStream.
 * @buffer: buffer where bytes pulled from the stream are stored.
 * @n: max number of bytes to read.
 * 
 * Read at most @n bytes from the @stream object and stores them
 * in the buffer pointed at by @buffer.
 * 
 * Return value: number of bytes actually read.
 **/
gint 
camel_stream_read (CamelStream *stream, gchar *buffer, gint n)
{
    return CS_CLASS (stream)->read (stream, buffer, n);
}

/**
 * camel_stream_write: 
 * @stream: a CamelStream object.
 * @buffer: buffer to write.
 * @n: number of bytes to write
 *
 * Write @n bytes from the buffer pointed at by @buffer into @stream.
 *
 * Return value: the number of bytes actually written
 *  in the stream.
 **/
gint
camel_stream_write (CamelStream *stream, const gchar *buffer, gint n)
{
    return CS_CLASS (stream)->write (stream, buffer, n);
}

/**
 * camel_stream_flush:
 * @stream: a CamelStream object
 * 
 * Flushes the contents of the stream to its backing store.
 **/
void
camel_stream_flush (CamelStream *stream)
{
    CS_CLASS (stream)->flush (stream);
}

/**
 * camel_stream_available: 
 * @stream: a CamelStream object
 * 
 * Return value: the number of bytes available.
 **/
gint 
camel_stream_available (CamelStream *stream)
{
    return CS_CLASS (stream)->available (stream);
}

/**
 * camel_stream_eos: 
 * @stream: a CamelStream object
 * 
 * Test if there are bytes left to read on the @stream object.
 * 
 * Return value: %TRUE if all the contents on the stream has been read, or
 * %FALSE if information is still available.
 **/
gboolean
camel_stream_eos (CamelStream *stream)
{
    return CS_CLASS (stream)->eos (stream);
}


/**
 * camel_stram_close: 
 * @stream: a CamelStream object.
 * 
 * Close the @stream object.
 **/
void
camel_stream_close (CamelStream *stream)
{
    CS_CLASS (stream)->close (stream);
}


/**
 * camel_stream_seek:
 * @stream: a CamelStream object.
 * @offset: offset value
 * @policy: what to do with the offset
 * 
 * 
 * 
 * Return value: new position, -1 if operation failed.
 **/
gint
camel_stream_seek (CamelStream *stream, gint offset, CamelStreamSeekPolicy policy)
{
    return CS_CLASS (stream)->seek (stream, offset, policy);
}




/***************** Utility functions ********************/

/**
 * came_stream_write_strings:
 * @stream: a CamelStream object.
 * @...: A %NULL terminated list of strings.
 *
 * This is a utility function that writes the list of
 * strings into the @stream object.
 */
void
camel_stream_write_strings (CamelStream *stream, ... )
{
    va_list args;
    const char *string;
    
    va_start(args, stream);
    string = va_arg (args, const char *);
    
    while (string) {
        camel_stream_write_string (stream, string);
        string = va_arg (args, char *);
    }
    va_end (args);
}