aboutsummaryrefslogtreecommitdiffstats
path: root/camel/camel-store.c
blob: a5ade87053269ea607b2d213ca6479dc6f35ee92 (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
/* -*- Mode: C; tab-width: 8; indent-tabs-mode: t; c-basic-offset: 8 -*- */
/* camelStore.c : Abstract class for an email store */

/* 
 *
 * 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 "camel-store.h"

static GtkObjectClass *parent_class=NULL;

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

static void camel_store_set_separator(CamelStore *store, gchar sep);
static CamelFolder *camel_store_get_root_folder(CamelStore *store);
static CamelFolder *camel_store_get_default_folder(CamelStore *store);



static void
camel_store_class_init (CamelStoreClass *camel_store_class)
{
    parent_class = gtk_type_class (camel_service_get_type ());
    
    /* virtual method definition */
    camel_store_class->set_separator = camel_store_set_separator;
    camel_store_class->get_separator = camel_store_get_separator;
    camel_store_class->get_folder = camel_store_get_folder;
    camel_store_class->get_root_folder = camel_store_get_root_folder;
    camel_store_class->get_default_folder = camel_store_get_default_folder;
    /* virtual method overload */
}







GtkType
camel_store_get_type (void)
{
    static GtkType camel_store_type = 0;
    
    if (!camel_store_type)  {
        GtkTypeInfo camel_store_info =  
        {
            "CamelStore",
            sizeof (CamelStore),
            sizeof (CamelStoreClass),
            (GtkClassInitFunc) camel_store_class_init,
            (GtkObjectInitFunc) NULL,
                /* reserved_1 */ NULL,
                /* reserved_2 */ NULL,
            (GtkClassInitFunc) NULL,
        };
        
        camel_store_type = gtk_type_unique (CAMEL_SERVICE_TYPE, &camel_store_info);
    }
    
    return camel_store_type;
}





/**
 * camel_store_new: create a new store from an URL
 * @url: The url representing this store
 * 
 * This routine creates a store from an URL name.
 * The URL may be for example:
 * pop3://user:passwd@host
 * 
 * WARNING : THIS METHOD DEFINITION IS SUBJECT TO 
 * CHANGES.
 * 
 * Return value: the newly created store
 **/
CamelStore *
camel_store_new(GString *url)
{
    /* this method must be overloaded by providers */
    CamelStore *store;
#warning must fill this
    /* here si what will happen here :
       In fact the method will take a Session object as a supplemental 
       argument. From this object and from the url protocol 
       (pop/mh/mbox ...) the correct provider will be selected an the 
       corresponding store object will be created */
    
}


/** 
 * camel_store_set_separator: set the character which separates this folder 
 * path from the folders names in a lower level of hierarchy.
 *
 * @store:
 * @sep:
 *
 **/
static void
camel_store_set_separator(CamelStore *store, gchar sep)
{
    store->separator = sep;
}



/** 
 * camel_store_get_separator: return the character which separates this folder 
 * path from the folders names in a lower level of hierarchy.
 *
 * @store: store
 *
 **/
gchar
camel_store_get_separator(CamelStore *store)
{
    g_assert(store);
    return store->separator;
}




/** 
 * camel_store_get_folder: return the folder corresponding to a path.
 * 
 * Returns the folder corresponding to the path "name". 
 * If the path begins with the separator caracter, it 
 * is relative to the root folder. Otherwise, it is
 * relative to the default folder.
 * The folder does not necessarily exist on the store.
 * To make sure it already exists, use its "exists" method.
 * If it does not exist, you can create it with its 
 * "create" method.
 *
 * @store: store
 * @folder_name: name of the folder to get
 *
 * Return value: the folder
 **/
CamelFolder *
camel_store_get_folder(CamelStore *store, GString *folder_name)
{

#warning fill this part in.
    return NULL;
}


/**
 * camel_store_get_root_folder : return the toplevel folder
 * 
 * Returns the folder which is at the top of the folder
 * hierarchy. This folder is generally different from
 * the default folder. 
 * 
 * @Return value: the tolevel folder.
 **/
static CamelFolder *
camel_store_get_root_folder(CamelStore *store)
{
    return NULL;
}

/** 
 * camel_store_get_default_folder : return the store default folder
 *
 * The default folder is the folder which is presented 
 * to the user in the default configuration. The default
 * is often the root folder.
 *
 *  @Return value: the default folder.
 **/
static CamelFolder *
camel_store_get_default_folder(CamelStore *store)
{
    return NULL;
}