aboutsummaryrefslogtreecommitdiffstats
path: root/widgets/table/e-cell.h
diff options
context:
space:
mode:
Diffstat (limited to 'widgets/table/e-cell.h')
-rw-r--r--widgets/table/e-cell.h18
1 files changed, 7 insertions, 11 deletions
diff --git a/widgets/table/e-cell.h b/widgets/table/e-cell.h
index faaf23b916..a76f7e37f4 100644
--- a/widgets/table/e-cell.h
+++ b/widgets/table/e-cell.h
@@ -13,11 +13,7 @@
#define E_IS_CELL(o) (GTK_CHECK_TYPE ((o), E_CELL_TYPE))
#define E_IS_CELL_CLASS(k) (GTK_CHECK_CLASS_TYPE ((k), E_CELL_TYPE))
-typedef struct _ECell ECell;
-typedef struct _ECellView ECellView;
-typedef enum _ECellFlags ECellFlags;
-
-enum _ECellFlags {
+typedef enum {
E_CELL_SELECTED = 1 << 0,
E_CELL_JUSTIFICATION = 3 << 1,
@@ -32,20 +28,20 @@ enum _ECellFlags {
E_CELL_FOCUSED = 1 << 3,
E_CELL_EDITING = 1 << 4,
-};
+} ECellFlags;
-struct _ECell {
+typedef struct {
GtkObject object;
-};
+} ECell;
-struct _ECellView {
+typedef struct {
ECell *ecell;
ETableModel *e_table_model;
void *e_table_item_view;
gint focus_x1, focus_y1, focus_x2, focus_y2;
gint focus_col, focus_row;
-};
+} ECellView;
#define E_CELL_IS_FOCUSED(ecell_view) (ecell_view->focus_x1 != -1)
@@ -87,7 +83,7 @@ gint e_cell_event (ECellView *ecell_view, GdkEvent *event, int model_c
void e_cell_realize (ECellView *ecell_view);
void e_cell_unrealize (ECellView *ecell_view);
-void e_cell_draw (ECellView *ecell_view, GdkDrawable *dr,
+void e_cell_draw (ECellView *ecell_view, GdkDrawable *drawable,
int model_col, int view_col, int row, ECellFlags flags,
int x1, int y1, int x2, int y2);
void e_cell_print (ECellView *ecell_view, GnomePrintContext *context,
f='#n158'>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 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450
/* -*- Mode: C; tab-width: 8; indent-tabs-mode: t; c-basic-offset: 8 -*- */
/* camelFolder.c : Abstract class for an email folder */

/* 
 *
 * Author : 
 *  Bertrand Guiheneuf <bertrand@helixcode.com>
 *
 * Copyright 1999, 2000 Helix Code, Inc. (http://www.helixcode.com)
 *
 * 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-folder.h"
#include "camel-exception.h"
#include "camel-store.h"
#include "string-utils.h"

static GtkObjectClass *parent_class=NULL;

/* Returns the class for a CamelFolder */
#define CF_CLASS(so) CAMEL_FOLDER_CLASS (GTK_OBJECT (so)->klass)




static void _init (CamelFolder *folder, CamelStore *parent_store,
           CamelFolder *parent_folder, const gchar *name,
           gchar separator, CamelException *ex);
static void _finalize (GtkObject *object);


static void _open (CamelFolder *folder, 
           CamelFolderOpenMode mode, 
           CamelException *ex);
static void _close (CamelFolder *folder, 
            gboolean expunge, 
            CamelException *ex);

#ifdef FOLDER_ASYNC_TEST

/* Async operations are not used for the moment */
static void _open_async (CamelFolder *folder, 
             CamelFolderOpenMode mode, 
             CamelFolderAsyncCallback callback, 
             gpointer user_data, 
             CamelException *ex);
static void _close_async (CamelFolder *folder, 
              gboolean expunge, 
              CamelFolderAsyncCallback callback, 
              gpointer user_data, 
              CamelException *ex);

#endif 

static const gchar *_get_name (CamelFolder *folder);
static const gchar *_get_full_name (CamelFolder *folder);


static gboolean _can_hold_folders  (CamelFolder *folder);
static gboolean _can_hold_messages (CamelFolder *folder);
static gboolean _exists  (CamelFolder  *folder, CamelException *ex);
static gboolean _is_open (CamelFolder *folder);
static guint32 _get_permanent_flags (CamelFolder *folder,
                     CamelException *ex);
static CamelFolderOpenMode _get_mode      (CamelFolder *folder,
                       CamelException *ex);


static gboolean _create (CamelFolder *folder, CamelException *ex);
static gboolean _delete (CamelFolder *folder, gboolean recurse,
             CamelException *ex);


static GList *_list_subfolders  (CamelFolder *folder, CamelException *ex);
static CamelFolder *_get_subfolder (CamelFolder *folder, 
                    const gchar *folder_name,
                    CamelException *ex);
static CamelFolder *_get_parent_folder (CamelFolder *folder,
                    CamelException *ex);
static CamelStore * _get_parent_store  (CamelFolder *folder,
                    CamelException *ex);


static gboolean _has_message_number_capability (CamelFolder *folder);
static CamelMimeMessage *_get_message_by_number (CamelFolder *folder, 
                         gint number, 
                         CamelException *ex);
static void _delete_message_by_number (CamelFolder *folder, 
                       gint number, 
                       CamelException *ex);
static gint _get_message_count        (CamelFolder *folder, 
                       CamelException *ex);


static gboolean _delete_messages (CamelFolder *folder, 
                  CamelException *ex);
static void _expunge         (CamelFolder *folder, 
                  CamelException *ex);
static void _append_message  (CamelFolder *folder, 
                  CamelMimeMessage *message, 
                  CamelException *ex);
static void _copy_message_to (CamelFolder *folder, 
                  CamelMimeMessage *message, 
                  CamelFolder *dest_folder, 
                  CamelException *ex);


static GList            *_get_uid_list       (CamelFolder *folder,
                          CamelException *ex);
static const gchar      *_get_message_uid    (CamelFolder *folder, 
                          CamelMimeMessage *message, 
                          CamelException *ex);
static CamelMimeMessage *_get_message_by_uid (CamelFolder *folder, 
                          const gchar *uid, 
                          CamelException *ex);
static void _delete_message_by_uid (CamelFolder *folder, 
                    const gchar *uid, 
                    CamelException *ex);

static GPtrArray *get_message_info (CamelFolder *folder, int first, int count);
static GPtrArray *get_subfolder_info (CamelFolder *folder, int first, int count);
static const CamelMessageInfo *summary_get_by_uid(CamelFolder *f, const char *uid);


static void
camel_folder_class_init (CamelFolderClass *camel_folder_class)
{
    GtkObjectClass *gtk_object_class = GTK_OBJECT_CLASS (camel_folder_class);
    
    parent_class = gtk_type_class (gtk_object_get_type ());
    
    /* virtual method definition */
    camel_folder_class->init = _init;
    camel_folder_class->open = _open;
#ifdef FOLDER_ASYNC_TEST
    camel_folder_class->open_async = _open_async;
#endif
    camel_folder_class->close = _close;
#ifdef FOLDER_ASYNC_TEST
    camel_folder_class->close_async = _close_async;
#endif
    camel_folder_class->get_name = _get_name;
    camel_folder_class->get_full_name = _get_full_name;
    camel_folder_class->can_hold_folders = _can_hold_folders;
    camel_folder_class->can_hold_messages = _can_hold_messages;
    camel_folder_class->exists = _exists;
    camel_folder_class->is_open = _is_open;
    camel_folder_class->get_subfolder = _get_subfolder;
    camel_folder_class->create = _create;
    camel_folder_class->delete = _delete;
    camel_folder_class->delete_messages = _delete_messages;
    camel_folder_class->get_parent_folder = _get_parent_folder;
    camel_folder_class->get_parent_store = _get_parent_store;
    camel_folder_class->get_mode = _get_mode;
    camel_folder_class->list_subfolders = _list_subfolders;
    camel_folder_class->expunge = _expunge;
    camel_folder_class->has_message_number_capability = _has_message_number_capability;
    camel_folder_class->get_message_by_number = _get_message_by_number;
    camel_folder_class->delete_message_by_number = _delete_message_by_number;
    camel_folder_class->get_message_count = _get_message_count;
    camel_folder_class->append_message = _append_message;
    camel_folder_class->get_permanent_flags = _get_permanent_flags;
    camel_folder_class->copy_message_to = _copy_message_to;
    camel_folder_class->get_message_uid = _get_message_uid;
    camel_folder_class->get_message_by_uid = _get_message_by_uid;
    camel_folder_class->delete_message_by_uid = _delete_message_by_uid;
    camel_folder_class->get_uid_list = _get_uid_list;

    camel_folder_class->get_subfolder_info = get_subfolder_info;
    camel_folder_class->get_message_info = get_message_info;
    camel_folder_class->summary_get_by_uid = summary_get_by_uid;

    /* virtual method overload */
    gtk_object_class->finalize = _finalize;
}







GtkType
camel_folder_get_type (void)
{
    static GtkType camel_folder_type = 0;
    
    if (!camel_folder_type) {
        GtkTypeInfo camel_folder_info = 
        {
            "CamelFolder",
            sizeof (CamelFolder),
            sizeof (CamelFolderClass),
            (GtkClassInitFunc) camel_folder_class_init,
            (GtkObjectInitFunc) NULL,
                /* reserved_1 */ NULL,
                /* reserved_2 */ NULL,
            (GtkClassInitFunc) NULL,
        };
        
        camel_folder_type = gtk_type_unique (gtk_object_get_type (), &camel_folder_info);
    }
    
    return camel_folder_type;
}


static void           
_finalize (GtkObject *object)
{
    CamelFolder *camel_folder = CAMEL_FOLDER (object);

    g_free (camel_folder->name);
    g_free (camel_folder->full_name);

    if (camel_folder->parent_store)
        gtk_object_unref (GTK_OBJECT (camel_folder->parent_store));
    if (camel_folder->parent_folder)
        gtk_object_unref (GTK_OBJECT (camel_folder->parent_folder));

    GTK_OBJECT_CLASS (parent_class)->finalize (object);
}


/**
 * _init: init the folder
 * @folder: folder object to initialize
 * @parent_store: parent store object of the folder
 * @parent_folder: parent folder of the folder (may be NULL)
 * @name: (short) name of the folder
 * @separator: separator between the parent folder name and this name
 * 
 * Initalizes the folder by setting the parent store, parent folder,
 * and name.
 **/
static void 
_init (CamelFolder *folder, CamelStore *parent_store,
       CamelFolder *parent_folder, const gchar *name,
       gchar separator, CamelException *ex)
{
    gchar *full_name;
    const gchar *parent_full_name;

    g_assert (folder != NULL);
    g_assert (parent_store != NULL);
    g_assert (folder->parent_store == NULL);
    
    folder->parent_store = parent_store;
    gtk_object_ref (GTK_OBJECT (parent_store));
    
    folder->parent_folder = parent_folder;
    if (parent_folder)
        gtk_object_ref (GTK_OBJECT (parent_folder));

    folder->open_mode = FOLDER_OPEN_UNKNOWN;
    folder->open_state = FOLDER_CLOSE;
    folder->separator = separator;

    /* if the folder already has a name, free it */ 
    g_free (folder->name);
    g_free (folder->full_name);
    
    /* set those fields to NULL now, so that if an 
       exception occurs, they will be set anyway */
    folder->name = NULL;
    folder->full_name = NULL;

    if (folder->parent_folder) {
        parent_full_name =
            camel_folder_get_full_name (folder->parent_folder);
        
        full_name = g_strdup_printf ("%s%c%s", parent_full_name,
                         folder->separator, name);
    } else {
        full_name = g_strdup_printf ("%c%s", folder->separator, name);
    }

    folder->name = g_strdup (name);
    folder->full_name = full_name;
}





static void
_open (CamelFolder *folder, 
       CamelFolderOpenMode mode, 
       CamelException *ex)
{
    if (folder->open_state == FOLDER_OPEN) {
        camel_exception_set (ex, 
                     CAMEL_EXCEPTION_FOLDER_INVALID_STATE,
                     "folder is already open");
        return;
    }

    folder->open_state = FOLDER_OPEN;
    folder->open_mode = mode;
}




/**
 * camel_folder_open: Open a folder
 * @folder: The folder object
 * @mode: open mode (R/W/RW ?)
 * @ex: exception object
 *
 * Open a folder in a given mode.
 * 
 **/
void 
camel_folder_open (CamelFolder *folder, 
           CamelFolderOpenMode mode, 
           CamelException *ex)
{   
    g_assert (folder != NULL);
    CF_CLASS (folder)->open (folder, mode, ex);
}




#ifdef FOLDER_ASYNC_TEST

static void
_open_async (CamelFolder *folder, 
         CamelFolderOpenMode mode, 
         CamelFolderAsyncCallback callback, 
         gpointer user_data, 
         CamelException *ex)
{
    g_warning ("CamelFolder::open_async not implemented for `%s'",
           gtk_type_name (GTK_OBJECT_TYPE (folder)));
}




/**
 * camel_folder_open: Open a folder
 * @folder: The folder object
 * @mode: open mode (R/W/RW ?)
 * @callback: function to call when the operation is over
 * @user_data: data to pass to the callback 
 * @ex: exception object
 *
 * Open a folder in a given mode. When the operation is over
 * the callback is called and the client program can determine
 * if the operation suceeded by examining the exception. 
 * 
 **/
void 
camel_folder_open_async (CamelFolder *folder, 
             CamelFolderOpenMode mode, 
             CamelFolderAsyncCallback callback, 
             gpointer user_data, 
             CamelException *ex)
{   
    g_assert (folder != NULL);
    CF_CLASS (folder)->open_async (folder, mode, callback, user_data, ex);
}


#endif /* FOLDER_ASYNC_TEST */



static void
_close (CamelFolder *folder, 
    gboolean expunge, 
    CamelException *ex)
{   
    folder->open_state = FOLDER_CLOSE;
}

/**
 * camel_folder_close: Close a folder.
 * @folder: The folder object
 * @expunge: if TRUE, the flagged message are deleted.
 * @ex: exception object
 *
 * Put a folder in its closed state, and possibly 
 * expunge the flagged messages. 
 * 
 **/
void 
camel_folder_close (CamelFolder *folder, 
            gboolean expunge, 
            CamelException *ex)
{
    g_assert (folder != NULL);
    CF_CLASS (folder)->close (folder, expunge, ex);
}




#ifdef FOLDER_ASYNC_TEST


static void
_close_async (CamelFolder *folder, 
          gboolean expunge, 
          CamelFolderAsyncCallback callback, 
          gpointer user_data, 
          CamelException *ex)
{   
    g_warning ("CamelFolder::close_async not implemented for `%s'",
           gtk_type_name (GTK_OBJECT_TYPE (folder)));
}

/**
 * camel_folder_close_async: Close a folder.
 * @folder: The folder object
 * @expunge: if TRUE, the flagged message are deleted.
 * @callback: function to call when the operation is over
 * @user_data: data to pass to the callback 
 * @ex: exception object
 *
 * Put a folder in its closed state, and possibly 
 * expunge the flagged messages. The callback is called 
 * when the operation is over and the client program can determine
 * if the operation suceeded by examining the exception. 
 * 
 **/
void 
camel_folder_close_async (CamelFolder *folder, 
              gboolean expunge, 
              CamelFolderAsyncCallback callback, 
              gpointer user_data, 
              CamelException *ex)
{
    g_assert (folder != NULL);
    CF_CLASS (folder)->close_async (folder, expunge, callback,
                    user_data, ex);
}


#endif


static const gchar *
_get_name (CamelFolder *folder)
{
    return folder->name;
}


/**
 * camel_folder_get_name: get the (short) name of the folder
 * @folder: 
 * 
 * get the name of the folder. The fully qualified name
 * can be obtained with the get_full_ame method (not implemented)
 *
 * Return value: name of the folder
 **/
const gchar *
camel_folder_get_name (CamelFolder *folder)
{
    g_assert (folder != NULL);
    return CF_CLASS (folder)->get_name (folder);
}



static const gchar *
_get_full_name (CamelFolder *folder)
{
    return folder->full_name;
}

/**
 * camel_folder_get_full_name:get the (full) name of the folder
 * @folder: folder to get the name 
 * 
 * get the name of the folder. 
 * 
 * Return value: full name of the folder
 **/
const gchar *
camel_folder_get_full_name (CamelFolder *folder)
{
    g_assert (folder != NULL);
    return CF_CLASS (folder)->get_full_name (folder);
}


/**
 * _can_hold_folders: tests if the folder can contain other folders
 * @folder: The folder object 
 * 
 * Tests if a folder can contain other folder 
 * (as for example MH folders)
 * 
 * Return value: 
 **/
static gboolean
_can_hold_folders (CamelFolder *folder)
{
    return folder->can_hold_folders;
}




/**
 * _can_hold_messages: tests if the folder can contain messages
 * @folder: The folder object
 * 
 * Tests if a folder object can contain messages. 
 * In the case it can not, it most surely can only 
 * contain folders (rare).
 * 
 * Return value: true if it can contain messages false otherwise
 **/
static gboolean
_can_hold_messages (CamelFolder *folder)
{
    return folder->can_hold_messages;
}



static gboolean
_exists (CamelFolder *folder, CamelException *ex)
{
    return FALSE;
}


/**
 * _exists: tests if the folder object exists in its parent store.
 * @folder: folder object
 * 
 * Test if a folder exists on a store. A folder can be 
 * created without physically on a store. In that case, 
 * use CamelFolder::create to create it 
 * 
 * Return value: true if the folder exists on the store false otherwise 
 **/
gboolean
camel_folder_exists (CamelFolder *folder, CamelException *ex)
{
    g_assert (folder != NULL);
    return CF_CLASS (folder)->exists (folder, ex);
}



/**
 * _is_open: test if the folder is open 
 * @folder: The folder object
 * 
 * Tests if a folder is open. If not open it can be opened 
 * CamelFolder::open
 * 
 * Return value: true if the folder exists, false otherwise
 **/
static gboolean
_is_open (CamelFolder *folder)
{
    return folder->open_state == FOLDER_OPEN;
} 


/**
 * _is_open: test if the folder is open 
 * @folder: The folder object
 * 
 * Tests if a folder is open. If not open it can be opened 
 * CamelFolder::open
 * 
 * Return value: true if the folder exists, false otherwise
 **/
gboolean
camel_folder_is_open (CamelFolder *folder)
{
    g_assert (folder != NULL);
    return CF_CLASS (folder)->is_open (folder);
} 


static CamelFolder *
_get_subfolder (CamelFolder *folder, 
        const gchar *folder_name, 
        CamelException *ex)
{
    CamelFolder *new_folder;
    gchar *full_name;
    const gchar *current_folder_full_name;
    
    g_assert (folder->parent_store != NULL);
    
    current_folder_full_name = camel_folder_get_full_name (folder);

    full_name = g_strdup_printf ("%s%c%s", current_folder_full_name,
                     folder->separator, folder_name);
    
    new_folder = camel_store_get_folder (folder->parent_store, full_name, ex);
    return new_folder;
}



/**
 * camel_folder_get_subfolder: return the (sub)folder object that is specified
 * @folder: the folder
 * @folder_name: subfolder path
 * 
 * This method returns a folder objects. This folder
 * is necessarily a subfolder of the current folder. 
 * It is an error to ask a folder begining with the 
 * folder separator character.  
 * 
 * Return value: Required folder. NULL if the subfolder object  could not be obtained
 **/
CamelFolder *
camel_folder_get_subfolder (CamelFolder *folder, gchar *folder_name, CamelException *ex)
{
    g_assert (folder != NULL);
    g_assert (folder_name != NULL);
    g_assert (camel_folder_is_open (folder));

    return CF_CLASS (folder)->get_subfolder (folder, folder_name, ex);
}




/**
 * _create: creates a folder on its store
 * @folder: a CamelFolder object.
 * 
 * this routine handles the recursion mechanism.
 * Children classes have to implement the actual
 * creation mechanism. They must call this method
 * before physically creating the folder in order
 * to be sure the parent folder exists.
 * Calling this routine on an existing folder is
 * not an error, and returns %TRUE.
 * 
 * Return value: %TRUE if the folder exists, %FALSE otherwise 
 **/
static gboolean
_create (CamelFolder *folder, CamelException *ex)
{
    gchar *prefix;
    gchar dich_result;
    CamelFolder *parent;
    
    g_assert (folder->parent_store != NULL);
    g_assert (folder->name != NULL);
    
    /* if the folder already exists on the 
       store, do nothing and return true */
    if (CF_CLASS (folder)->exists (folder, ex))
        return TRUE;
    
    
    if (folder->parent_folder) {
        camel_folder_create (folder->parent_folder, ex);
        if (camel_exception_get_id (ex)) return FALSE;
    }
    else {   
        if (folder->full_name) {
            dich_result = string_dichotomy (
                            folder->full_name,
                            folder->separator,
                            &prefix, NULL,
                            STRING_DICHOTOMY_STRIP_TRAILING | STRING_DICHOTOMY_RIGHT_DIR);
            if (dich_result!='o') {
                if (prefix == NULL) {
                    /* separator is the first caracter, no folder above */
                     return TRUE;
                }
            } else {
                parent = camel_store_get_folder (folder->parent_store, prefix, ex);
                camel_folder_create (parent, ex);
                if (camel_exception_get_id (ex)) return FALSE;
            }
        }
    }   
    return TRUE;
}


/**
 * camel_folder_create: create the folder object on the physical store
 * @folder: folder object to create
 * 
 * This routine physically creates the folder object on 
 * the store. Having created the  object does not
 * mean the folder physically exists. If it does not
 * exists, this routine will create it.
 * if the folder full name contains more than one level
 * of hierarchy, all folders between the current folder
 * and the last folder name will be created if not existing.
 * 
 * Return value: 
 **/
gboolean
camel_folder_create (CamelFolder *folder, CamelException *ex)
{
    g_assert (folder != NULL);
    g_assert (!camel_folder_is_open (folder));

    return CF_CLASS (folder)->create (folder, ex);
}





/**
 * _delete: delete folder 
 * @folder: folder to delete
 * @recurse: true is subfolders must also be deleted
 * 
 * Delete a folder and its subfolders (if recurse is TRUE).
 * The scheme is the following:
 * 1) delete all messages in the folder
 * 2) if recurse is FALSE, and if there are subfolders
 *    return FALSE, else delete current folder and retuen TRUE
 *    if recurse is TRUE, delete subfolders, delete
 *    current folder and return TRUE
 * 
 * subclasses implementing a protocol with a different 
 * deletion behaviour must emulate this one or implement
 * empty folders deletion and call  this routine which 
 * will do all the works for them.
 * Opertions must be done in the folllowing order:
 *  - call this routine
 *  - delete empty folder
 * 
 * Return value: true if the folder has been deleted
 **/
static gboolean
_delete (CamelFolder *folder, gboolean recurse, CamelException *ex)
{
    GList *subfolders=NULL;
    GList *sf;
    gboolean ok;
    
    /* delete all messages in the folder */
    CF_CLASS (folder)->delete_messages (folder, ex);
    if (camel_exception_get_id (ex)) return FALSE;

    subfolders = CF_CLASS (folder)->list_subfolders (folder, ex); 
    if (camel_exception_get_id (ex)) {
        if (subfolders) g_list_free (subfolders);
        return FALSE;
    }
    
        ok = TRUE;
    if (recurse) { /* delete subfolders */
        if (subfolders) {
            sf = subfolders;
            do {
                CF_CLASS (sf->data)->delete (CAMEL_FOLDER (sf->data), TRUE, ex);
                if (camel_exception_get_id (ex)) ok = FALSE;
            } while (ok && (sf = sf->next));
        }
    } else if (subfolders) {
        camel_exception_set (ex, CAMEL_EXCEPTION_FOLDER_NON_EMPTY,
                     "folder has subfolders");
        ok = FALSE;
    }
    
    if (subfolders) g_list_free (subfolders);

    return ok;
}



/**
 * camel_folder_delete: delete a folder
 * @folder: folder to delete
 * @recurse: TRUE if subfolders must be deleted
 * 
 * Delete a folder. All messages in the folder 
 * are deleted before the folder is deleted. 
 * When recurse is true, all subfolders are
 * deleted too. When recurse is FALSE and folder 
 * contains subfolders, all messages are deleted,
 * but folder deletion fails. 
 * 
 * Return value: TRUE if deletion was successful
 **/
gboolean 
camel_folder_delete (CamelFolder *folder, gboolean recurse, CamelException *ex)
{
    g_assert (folder != NULL);
    g_assert (!camel_folder_is_open (folder));

    return CF_CLASS (folder)->delete (folder, recurse, ex);
}





/**
 * _delete_messages: delete all messages in the folder
 * @folder: 
 * 
 * 
 * 
 * Return value: 
 **/
static gboolean 
_delete_messages (CamelFolder *folder, CamelException *ex)
{
    g_warning ("CamelFolder::delete_messages not implemented for `%s'",
           gtk_type_name (GTK_OBJECT_TYPE (folder)));
    return FALSE;
}


/**
 * camel_folder_delete_messages: delete all messages in the folder
 * @folder: folder 
 * 
 * delete all messages stored in a folder
 * 
 * Return value: TRUE if the messages could be deleted
 **/
gboolean
camel_folder_delete_messages (CamelFolder *folder, CamelException *ex)
{
    g_assert (folder != NULL);
    g_assert (!camel_folder_is_open (folder));

    return CF_CLASS (folder)->delete_messages (folder, ex);
}






/**
 * _get_parent_folder: return parent folder
 * @folder: folder to get the parent
 * 
 * 
 * 
 * Return value: 
 **/
static CamelFolder *
_get_parent_folder (CamelFolder *folder, CamelException *ex)
{
    return folder->parent_folder;
}


/**
 * camel_folder_get_parent_folder:return parent folder
 * @folder: folder to get the parent
 * 
 * 
 * 
 * Return value: 
 **/
CamelFolder *
camel_folder_get_parent_folder (CamelFolder *folder, CamelException *ex)
{
    g_assert (folder != NULL);
    return CF_CLASS (folder)->get_parent_folder (folder, ex);
}


/**
 * _get_parent_store: return parent store
 * @folder: folder to get the parent
 * 
 * 
 * 
 * Return value: 
 **/
static CamelStore *
_get_parent_store (CamelFolder *folder, CamelException *ex)
{
    return folder->parent_store;
}


/**
 * camel_folder_get_parent_store: return parent store
 * @folder: folder to get the parent
 * 
 * Return the parent store of a folder
 * 
 * Return value: the parent store. 
 **/
CamelStore *
camel_folder_get_parent_store (CamelFolder *folder, CamelException *ex)
{
    g_assert (folder != NULL);
    return CF_CLASS (folder)->get_parent_store (folder, ex);
}




static CamelFolderOpenMode
_get_mode (CamelFolder *folder, CamelException *ex)
{
    return folder->open_mode;
}


/**
 * camel_folder_get_mode: return the open mode of a folder
 * @folder: 
 * 
 * 
 * 
 * Return value:  open mode of the folder
 **/
CamelFolderOpenMode
camel_folder_get_mode (CamelFolder *folder, CamelException *ex)
{
    g_assert (folder != NULL);
    return CF_CLASS (folder)->get_mode (folder, ex);
}




static GList *
_list_subfolders (CamelFolder *folder, CamelException *ex)
{
    g_warning ("CamelFolder::list_folders not implemented for `%s'",
           gtk_type_name (GTK_OBJECT_TYPE (folder)));
    return NULL;
}


/**
 * camel_folder_list_subfolders: list subfolders in a folder
 * @folder: the folder
 * 
 * List subfolders in a folder. 
 * 
 * Return value: list of subfolders
 **/
GList *
camel_folder_list_subfolders (CamelFolder *folder, CamelException *ex)
{
    g_assert (folder != NULL);
    g_assert (camel_folder_is_open (folder));

    return CF_CLASS (folder)->list_subfolders (folder, ex);
}




static void
_expunge (CamelFolder *folder, CamelException *ex)
{
    g_warning ("CamelFolder::expunge not implemented for `%s'",
           gtk_type_name (GTK_OBJECT_TYPE (folder)));
}


/**
 * camel_folder_expunge: physically delete messages marked as "DELETED"
 * @folder: the folder
 * 
 * Delete messages which have been marked as  "DELETED"
 * 
 * Return value: list of expunged messages 
 **/
void
camel_folder_expunge (CamelFolder *folder, CamelException *ex)
{
    g_assert (folder != NULL);
    g_assert (!camel_folder_is_open (folder));

    return CF_CLASS (folder)->expunge (folder, ex);
}


static gboolean 
_has_message_number_capability (CamelFolder *folder)
{
    g_warning ("CamelFolder::has_message_number_capability not "
           "implemented for `%s'",
           gtk_type_name (GTK_OBJECT_TYPE (folder)));
    return FALSE;

}


/**
 * camel_folder_has_message_number_capability: tests if the message can be numbered within the folder
 * @folder: folder to test
 * 
 * Test if the message in this folder can be
 * obtained via the get_by_number method. 
 * Usually, when the folder has the UID 
 * capability, messages should be referred to
 * by their UID rather than by their number
 * as the UID is more reliable. 
 * 
 * Return value: TRUE if the folder supports message numbering, FALSE otherwise.
 **/
gboolean 
camel_folder_has_message_number_capability (CamelFolder *folder)
{   
    g_assert (folder != NULL);
    return CF_CLASS (folder)->has_message_number_capability (folder);
}




static CamelMimeMessage *
_get_message_by_number (CamelFolder *folder, gint number, CamelException *ex)
{
    g_warning ("CamelFolder::get_message_by_number not implemented "
           "for `%s'", gtk_type_name (GTK_OBJECT_TYPE (folder)));
    return NULL;
}




/**
 * camel_folder_get_message_by_number: return the message corresponding to that number in the folder
 * @folder: a CamelFolder object
 * @number: the number of the message within the folder.
 * 
 * Return the message corresponding to that number within the folder.
 * 
 * Return value: A pointer on the corresponding message or NULL if no corresponding message exists
 **/
CamelMimeMessage *
camel_folder_get_message_by_number (CamelFolder *folder, gint number, CamelException *ex)
{
    g_assert (folder != NULL);
    g_assert (camel_folder_is_open (folder));

    return CF_CLASS (folder)->get_message_by_number (folder, number, ex);
}


static void
_delete_message_by_number (CamelFolder *folder, gint number,
               CamelException *ex)
{
    g_warning ("CamelFolder::delete_message_by_number not implemented "
           "for `%s'", gtk_type_name (GTK_OBJECT_TYPE (folder)));
}

/**
 * camel_folder_delete_message_by_number: delete the message
 * corresponding to that number in the folder
 * @folder: a CamelFolder object
 * @number: the number of the message within the folder.
 * 
 * Delete the message corresponding to that number within the folder.
 * 
 **/
void
camel_folder_delete_message_by_number (CamelFolder *folder, gint number,
                       CamelException *ex)
{
    g_assert (folder != NULL);
    g_assert (camel_folder_is_open (folder));

    return CF_CLASS (folder)->delete_message_by_number (folder, number,
                                ex);
}


static gint
_get_message_count (CamelFolder *folder, CamelException *ex)
{
    g_warning ("CamelFolder::get_message_count not implemented "
           "for `%s'", gtk_type_name (GTK_OBJECT_TYPE (folder)));
    return -1;
}



/**
 * camel_folder_get_message_count: get the number of messages in the folder
 * @folder: A CamelFolder object
 * 
 * Returns the number of messages in the folder.
 * 
 * Return value: the number of messages or -1 if unknown.
 **/
gint
camel_folder_get_message_count (CamelFolder *folder, CamelException *ex)
{
    g_assert (folder != NULL);
    g_assert (camel_folder_is_open (folder));

    return CF_CLASS (folder)->get_message_count (folder, ex);
}


static void
_append_message (CamelFolder *folder, CamelMimeMessage *message,
         CamelException *ex)
{
    g_warning ("CamelFolder::append_message not implemented for `%s'",
           gtk_type_name (GTK_OBJECT_TYPE (folder)));
    return;

}


/**
 * camel_folder_append_message: add a message to a folder
 * @folder: folder object to add the message to
 * @message: message object
 * @ex: exception object
 * 
 * Add a message to a folder.
 * 
 **/
void 
camel_folder_append_message (CamelFolder *folder, 
                 CamelMimeMessage *message, 
                 CamelException *ex)
{   
    g_assert (folder != NULL);
    g_assert (camel_folder_is_open (folder));

    CF_CLASS (folder)->append_message (folder, message, ex);
}


static guint32
_get_permanent_flags (CamelFolder *folder, CamelException *ex)
{
    return folder->permanent_flags;
}


guint32
camel_folder_get_permanent_flags (CamelFolder *folder, CamelException *ex)
{
    g_assert (folder != NULL);
    return CF_CLASS (folder)->get_permanent_flags (folder, ex);
}




static void
_copy_message_to (CamelFolder *folder, CamelMimeMessage *message, CamelFolder *dest_folder, CamelException *ex)
{
    camel_folder_append_message (dest_folder, message, ex);
}


void
camel_folder_copy_message_to (CamelFolder *folder, 
                  CamelMimeMessage *message, 
                  CamelFolder *dest_folder, 
                  CamelException *ex)
{
    g_assert (folder != NULL);
    g_assert (camel_folder_is_open (folder));

    CF_CLASS (folder)->copy_message_to (folder, message, dest_folder, ex);;
}

/* summary stuff */
static GPtrArray *
get_subfolder_info (CamelFolder *folder, int first, int count)
{
    g_warning ("CamelFolder::get_subfolder_info not implemented for `%s'", gtk_type_name (GTK_OBJECT_TYPE (folder)));
    return NULL;
}

/**
 * camel_folder_summary_get_subfolder_info: return an array of subfolders
 * @summary: a summary
 * @first: the index of the first subfolder to return information for
 * (starting from 0)
 * @count: the number of subfolders to return information for
 *
 * Returns an array of pointers to CamelFolderInfo objects. The caller
 * must free the array when it is done with it, but should not modify
 * the elements.
 *
 * Return value: an array containing information about the subfolders.
 **/
GPtrArray *
camel_folder_summary_get_subfolder_info (CamelFolder *folder,
                     int first, int count)
{
    g_assert (folder != NULL);
    return CF_CLASS (folder)->get_subfolder_info (folder, first, count);
}


static GPtrArray *
get_message_info (CamelFolder *folder, int first, int count)
{
    g_warning ("CamelFolder::get_message_info not implemented for `%s'", gtk_type_name (GTK_OBJECT_TYPE (folder)));
    return NULL;
}

/**
 * camel_folder_summary_get_message_info: return an array of messages
 * @folder: a camel folder
 * @first: the index of the first message to return information for
 * (starting from 0)
 * @count: the number of messages to return information for
 *
 * Returns an array of pointers to CamelMessageInfo objects. The caller
 * must free the array when it is done with it, but should not modify
 * the elements.
 *
 * Return value: an array containing information about the messages.
 **/
GPtrArray *
camel_folder_summary_get_message_info (CamelFolder *folder,
                       int first, int count)
{
    g_assert (folder != NULL);
    return CF_CLASS (folder)->get_message_info (folder, first, count);
}

static const CamelMessageInfo *
summary_get_by_uid(CamelFolder *f, const char *uid)
{
    g_warning("folder::summary_get_by_uid() unimplemented");
    return NULL;
}

/**
 * camel_folder_summary_get_by_uid:
 * @folder: 
 * @uid: 
 * 
 * Get a single summary entry, by uid.
 * 
 * Return value: 
 **/
const CamelMessageInfo *camel_folder_summary_get_by_uid (CamelFolder *folder, const char *uid)
{
    g_assert (folder != NULL);
    g_assert(uid != NULL);
    return CF_CLASS (folder)->summary_get_by_uid (folder, uid);
}

/* summary stuff */
/* TODO: is this function required anyway? */
gboolean
camel_folder_has_summary_capability (CamelFolder *folder)
{
    g_assert (folder != NULL);
    return folder->has_summary_capability;
}


/* UIDs stuff */

/**
 * camel_folder_has_uid_capability: detect if the folder support UIDs
 * @folder: Folder object
 * 
 * Detects if a folder supports UID operations, that is
 * reference messages by a Unique IDentifier instead
 * of by message number.  
 * 
 * Return value: TRUE if the folder supports UIDs 
 **/
gboolean
camel_folder_has_uid_capability (CamelFolder *folder)
{
    g_assert (folder != NULL);
    return folder->has_uid_capability;
}



static const gchar *
_get_message_uid (CamelFolder *folder, CamelMimeMessage *message, CamelException *ex)
{
    g_warning ("CamelFolder::get_message_uid not implemented for `%s'",
           gtk_type_name (GTK_OBJECT_TYPE (folder)));
    return NULL;
}

/**
 * camel_folder_get_message_uid: get the UID of a message in a folder
 * @folder: Folder in which the UID must refer to
 * @message: Message object 
 * 
 * Return the UID of a message relatively to a folder.
 * A message can have different UID, each one corresponding
 * to a different folder, if the message is referenced in
 * several folders. 
 * 
 * Return value: The UID of the message in the folder
 **/
const gchar * 
camel_folder_get_message_uid (CamelFolder *folder, CamelMimeMessage *message, CamelException *ex)
{
    g_assert (folder != NULL);
    g_assert (folder->has_uid_capability);
    g_assert (camel_folder_is_open (folder));

    return CF_CLASS (folder)->get_message_uid (folder, message, ex);
}



static CamelMimeMessage *
_get_message_by_uid (CamelFolder *folder, const gchar *uid, CamelException *ex)
{
    g_warning ("CamelFolder::get_message_by_uid not implemented for `%s'",
           gtk_type_name (GTK_OBJECT_TYPE (folder)));
    return NULL;
}


/**
 * camel_folder_get_message_by_uid: Get a message by its UID in a folder
 * @folder: the folder object
 * @uid: the UID
 * 
 * Get a message from its UID in the folder. Messages 
 * are cached within a folder, that is, asking twice
 * for the same UID returns the same message object.
 * 
 * Return value: Message corresponding to the UID
 **/
CamelMimeMessage *
camel_folder_get_message_by_uid  (CamelFolder *folder, const gchar *uid, CamelException *ex)
{
    g_assert (folder != NULL);
    g_assert (folder->has_uid_capability);
    g_assert (camel_folder_is_open (folder));

    return CF_CLASS (folder)->get_message_by_uid (folder, uid, ex);
}

static void
_delete_message_by_uid (CamelFolder *folder, const gchar *uid,
            CamelException *ex)
{
    g_warning ("CamelFolder::delete_message_by_uid not implemented "
           "for `%s'", gtk_type_name (GTK_OBJECT_TYPE (folder)));
}


/**
 * camel_folder_delete_message_by_uid: Delete a message by its UID in a folder
 * @folder: the folder object
 * @uid: the UID
 * 
 * Delete a message from a folder given its UID.
 *
 **/
void
camel_folder_delete_message_by_uid  (CamelFolder *folder, const gchar *uid,
                     CamelException *ex)
{
    g_assert (folder != NULL);
    g_assert (folder->has_uid_capability);
    g_assert (camel_folder_is_open (folder));

    return CF_CLASS (folder)->delete_message_by_uid (folder, uid, ex);
}

static GList *
_get_uid_list  (CamelFolder *folder, CamelException *ex)
{
    g_warning ("CamelFolder::get_uid_list not implemented for `%s'",
           gtk_type_name (GTK_OBJECT_TYPE (folder)));
    return NULL;
}

/**
 * camel_folder_get_uid_list: get the list of UID in a folder
 * @folder: folder object
 * 
 * get the list of UID available in a folder. This
 * routine is usefull to know what messages are
 * available when the folder does not support
 * summaries. The UIDs in the list must not be freed,
 * the folder object caches them.
 * 
 * Return value: Glist of UID correspondind to the messages available in the folder.
 **/
GList *
camel_folder_get_uid_list  (CamelFolder *folder, CamelException *ex)
{
    g_assert (folder != NULL);
    g_assert (folder->has_uid_capability);
    g_assert (camel_folder_is_open (folder));

    return CF_CLASS (folder)->get_uid_list (folder, ex);
}

/**
 * camel_folder_has_search_capability:
 * @folder: Folder object
 * 
 * Checks if a folder supports searching.
 * 
 * Return value: TRUE if the folder supports UIDs 
 **/
gboolean
camel_folder_has_search_capability (CamelFolder *folder)
{
    g_assert (folder != NULL);
    return folder->has_search_capability;
}

GList *camel_folder_search_by_expression  (CamelFolder *folder,
                       const char *expression,
                       CamelException *ex)
{
    g_assert (folder != NULL);
    g_return_val_if_fail (folder->has_search_capability, NULL);

    return CF_CLASS (folder)->search_by_expression (folder, expression, ex);
}

/* **** */