annotate lib-src/pop.h @ 934:c925bacdda60

[xemacs-hg @ 2002-07-29 09:21:12 by michaels] 2002-07-17 Marcus Crestani <crestani@informatik.uni-tuebingen.de> Markus Kaltenbach <makalten@informatik.uni-tuebingen.de> Mike Sperber <mike@xemacs.org> configure flag to turn these changes on: --use-kkcc First we added a dumpable flag to lrecord_implementation. It shows, if the object is dumpable and should be processed by the dumper. * lrecord.h (struct lrecord_implementation): added dumpable flag (MAKE_LRECORD_IMPLEMENTATION): fitted the different makro definitions to the new lrecord_implementation and their calls. Then we changed mark_object, that it no longer needs a mark method for those types that have pdump descritions. * alloc.c: (mark_object): If the object has a description, the new mark algorithm is called, and the object is marked according to its description. Otherwise it uses the mark method like before. These procedures mark objects according to their descriptions. They are modeled on the corresponding pdumper procedures. (mark_with_description): (get_indirect_count): (structure_size): (mark_struct_contents): These procedures still call mark_object, this is needed while there are Lisp_Objects without descriptions left. We added pdump descriptions for many Lisp_Objects: * extents.c: extent_auxiliary_description * database.c: database_description * gui.c: gui_item_description * scrollbar.c: scrollbar_instance_description * toolbar.c: toolbar_button_description * event-stream.c: command_builder_description * mule-charset.c: charset_description * device-msw.c: devmode_description * dialog-msw.c: mswindows_dialog_id_description * eldap.c: ldap_description * postgresql.c: pgconn_description pgresult_description * tooltalk.c: tooltalk_message_description tooltalk_pattern_description * ui-gtk.c: emacs_ffi_description emacs_gtk_object_description * events.c: * events.h: * event-stream.c: * event-Xt.c: * event-gtk.c: * event-tty.c: To write a pdump description for Lisp_Event, we converted every struct in the union event to a Lisp_Object. So we created nine new Lisp_Objects: Lisp_Key_Data, Lisp_Button_Data, Lisp_Motion_Data, Lisp_Process_Data, Lisp_Timeout_Data, Lisp_Eval_Data, Lisp_Misc_User_Data, Lisp_Magic_Data, Lisp_Magic_Eval_Data. We also wrote makro selectors and mutators for the fields of the new designed Lisp_Event and added everywhere these new abstractions. We implemented XD_UNION support in (mark_with_description), so we can describe exspecially console/device specific data with XD_UNION. To describe with XD_UNION, we added a field to these objects, which holds the variant type of the object. This field is initialized in the appendant constructor. The variant is an integer, it has also to be described in an description, if XD_UNION is used. XD_UNION is used in following descriptions: * console.c: console_description (get_console_variant): returns the variant (create_console): added variant initialization * console.h (console_variant): the different console types * console-impl.h (struct console): added enum console_variant contype * device.c: device_description (Fmake_device): added variant initialization * device-impl.h (struct device): added enum console_variant devtype * objects.c: image_instance_description font_instance_description (Fmake_color_instance): added variant initialization (Fmake_font_instance): added variant initialization * objects-impl.h (struct Lisp_Color_Instance): added color_instance_type * objects-impl.h (struct Lisp_Font_Instance): added font_instance_type * process.c: process_description (make_process_internal): added variant initialization * process.h (process_variant): the different process types
author michaels
date Mon, 29 Jul 2002 09:21:25 +0000
parents 023b83f4e54b
children bdfcf05f635b
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
54
05472e90ae02 Import from CVS: tag r19-16-pre2
cvs
parents:
diff changeset
1 /* pop.h: Header file for the "pop.c" client POP3 protocol.
05472e90ae02 Import from CVS: tag r19-16-pre2
cvs
parents:
diff changeset
2 Copyright (c) 1991,1993 Free Software Foundation, Inc.
05472e90ae02 Import from CVS: tag r19-16-pre2
cvs
parents:
diff changeset
3 Written by Jonathan Kamens, jik@security.ov.com.
05472e90ae02 Import from CVS: tag r19-16-pre2
cvs
parents:
diff changeset
4
613
023b83f4e54b [xemacs-hg @ 2001-06-10 10:42:16 by ben]
ben
parents: 54
diff changeset
5 This file is part of XEmacs.
54
05472e90ae02 Import from CVS: tag r19-16-pre2
cvs
parents:
diff changeset
6
613
023b83f4e54b [xemacs-hg @ 2001-06-10 10:42:16 by ben]
ben
parents: 54
diff changeset
7 XEmacs is free software; you can redistribute it and/or modify
54
05472e90ae02 Import from CVS: tag r19-16-pre2
cvs
parents:
diff changeset
8 it under the terms of the GNU General Public License as published by
05472e90ae02 Import from CVS: tag r19-16-pre2
cvs
parents:
diff changeset
9 the Free Software Foundation; either version 2, or (at your option)
05472e90ae02 Import from CVS: tag r19-16-pre2
cvs
parents:
diff changeset
10 any later version.
05472e90ae02 Import from CVS: tag r19-16-pre2
cvs
parents:
diff changeset
11
613
023b83f4e54b [xemacs-hg @ 2001-06-10 10:42:16 by ben]
ben
parents: 54
diff changeset
12 XEmacs is distributed in the hope that it will be useful,
54
05472e90ae02 Import from CVS: tag r19-16-pre2
cvs
parents:
diff changeset
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
05472e90ae02 Import from CVS: tag r19-16-pre2
cvs
parents:
diff changeset
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
05472e90ae02 Import from CVS: tag r19-16-pre2
cvs
parents:
diff changeset
15 GNU General Public License for more details.
05472e90ae02 Import from CVS: tag r19-16-pre2
cvs
parents:
diff changeset
16
05472e90ae02 Import from CVS: tag r19-16-pre2
cvs
parents:
diff changeset
17 You should have received a copy of the GNU General Public License
613
023b83f4e54b [xemacs-hg @ 2001-06-10 10:42:16 by ben]
ben
parents: 54
diff changeset
18 along with XEmacs; see the file COPYING. If not, write to
54
05472e90ae02 Import from CVS: tag r19-16-pre2
cvs
parents:
diff changeset
19 the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
05472e90ae02 Import from CVS: tag r19-16-pre2
cvs
parents:
diff changeset
20 Boston, MA 02111-1307, USA. */
05472e90ae02 Import from CVS: tag r19-16-pre2
cvs
parents:
diff changeset
21
05472e90ae02 Import from CVS: tag r19-16-pre2
cvs
parents:
diff changeset
22 #include <stdio.h>
05472e90ae02 Import from CVS: tag r19-16-pre2
cvs
parents:
diff changeset
23
05472e90ae02 Import from CVS: tag r19-16-pre2
cvs
parents:
diff changeset
24 #define GETLINE_MIN 1024 /* the getline buffer starts out this */
05472e90ae02 Import from CVS: tag r19-16-pre2
cvs
parents:
diff changeset
25 /* size */
05472e90ae02 Import from CVS: tag r19-16-pre2
cvs
parents:
diff changeset
26 #define GETLINE_INCR 1024 /* the getline buffer is grown by this */
05472e90ae02 Import from CVS: tag r19-16-pre2
cvs
parents:
diff changeset
27 /* size when it needs to grow */
05472e90ae02 Import from CVS: tag r19-16-pre2
cvs
parents:
diff changeset
28
05472e90ae02 Import from CVS: tag r19-16-pre2
cvs
parents:
diff changeset
29 extern char pop_error[];
05472e90ae02 Import from CVS: tag r19-16-pre2
cvs
parents:
diff changeset
30 extern int pop_debug;
05472e90ae02 Import from CVS: tag r19-16-pre2
cvs
parents:
diff changeset
31
05472e90ae02 Import from CVS: tag r19-16-pre2
cvs
parents:
diff changeset
32 struct _popserver
05472e90ae02 Import from CVS: tag r19-16-pre2
cvs
parents:
diff changeset
33 {
05472e90ae02 Import from CVS: tag r19-16-pre2
cvs
parents:
diff changeset
34 int file, data;
05472e90ae02 Import from CVS: tag r19-16-pre2
cvs
parents:
diff changeset
35 char *buffer;
05472e90ae02 Import from CVS: tag r19-16-pre2
cvs
parents:
diff changeset
36 int buffer_size, buffer_index;
05472e90ae02 Import from CVS: tag r19-16-pre2
cvs
parents:
diff changeset
37 int in_multi;
05472e90ae02 Import from CVS: tag r19-16-pre2
cvs
parents:
diff changeset
38 int trash_started;
05472e90ae02 Import from CVS: tag r19-16-pre2
cvs
parents:
diff changeset
39 };
05472e90ae02 Import from CVS: tag r19-16-pre2
cvs
parents:
diff changeset
40
05472e90ae02 Import from CVS: tag r19-16-pre2
cvs
parents:
diff changeset
41 typedef struct _popserver *popserver;
05472e90ae02 Import from CVS: tag r19-16-pre2
cvs
parents:
diff changeset
42
05472e90ae02 Import from CVS: tag r19-16-pre2
cvs
parents:
diff changeset
43 /*
05472e90ae02 Import from CVS: tag r19-16-pre2
cvs
parents:
diff changeset
44 * Valid flags for the pop_open function.
05472e90ae02 Import from CVS: tag r19-16-pre2
cvs
parents:
diff changeset
45 */
05472e90ae02 Import from CVS: tag r19-16-pre2
cvs
parents:
diff changeset
46
05472e90ae02 Import from CVS: tag r19-16-pre2
cvs
parents:
diff changeset
47 #define POP_NO_KERBEROS (1<<0)
05472e90ae02 Import from CVS: tag r19-16-pre2
cvs
parents:
diff changeset
48 #define POP_NO_HESIOD (1<<1)
05472e90ae02 Import from CVS: tag r19-16-pre2
cvs
parents:
diff changeset
49 #define POP_NO_GETPASS (1<<2)
05472e90ae02 Import from CVS: tag r19-16-pre2
cvs
parents:
diff changeset
50
05472e90ae02 Import from CVS: tag r19-16-pre2
cvs
parents:
diff changeset
51 #ifdef __STDC__
05472e90ae02 Import from CVS: tag r19-16-pre2
cvs
parents:
diff changeset
52 #define _ARGS(a) a
05472e90ae02 Import from CVS: tag r19-16-pre2
cvs
parents:
diff changeset
53 #else
05472e90ae02 Import from CVS: tag r19-16-pre2
cvs
parents:
diff changeset
54 #define _ARGS(a) ()
05472e90ae02 Import from CVS: tag r19-16-pre2
cvs
parents:
diff changeset
55 #endif
05472e90ae02 Import from CVS: tag r19-16-pre2
cvs
parents:
diff changeset
56
05472e90ae02 Import from CVS: tag r19-16-pre2
cvs
parents:
diff changeset
57 extern popserver pop_open _ARGS((char *host, char *username, char *password,
05472e90ae02 Import from CVS: tag r19-16-pre2
cvs
parents:
diff changeset
58 int flags));
05472e90ae02 Import from CVS: tag r19-16-pre2
cvs
parents:
diff changeset
59 extern int pop_stat _ARGS((popserver server, int *count, int *size));
05472e90ae02 Import from CVS: tag r19-16-pre2
cvs
parents:
diff changeset
60 extern int pop_list _ARGS((popserver server, int message, int **IDs,
05472e90ae02 Import from CVS: tag r19-16-pre2
cvs
parents:
diff changeset
61 int **size));
05472e90ae02 Import from CVS: tag r19-16-pre2
cvs
parents:
diff changeset
62 extern char *pop_retrieve _ARGS((popserver server, int message, int markfrom));
05472e90ae02 Import from CVS: tag r19-16-pre2
cvs
parents:
diff changeset
63 extern int pop_retrieve_first _ARGS((popserver server, int message,
05472e90ae02 Import from CVS: tag r19-16-pre2
cvs
parents:
diff changeset
64 char **response));
05472e90ae02 Import from CVS: tag r19-16-pre2
cvs
parents:
diff changeset
65 extern int pop_retrieve_next _ARGS((popserver server, char **line));
05472e90ae02 Import from CVS: tag r19-16-pre2
cvs
parents:
diff changeset
66 extern int pop_retrieve_flush _ARGS((popserver server));
05472e90ae02 Import from CVS: tag r19-16-pre2
cvs
parents:
diff changeset
67 extern int pop_top_first _ARGS((popserver server, int message, int lines,
05472e90ae02 Import from CVS: tag r19-16-pre2
cvs
parents:
diff changeset
68 char **response));
05472e90ae02 Import from CVS: tag r19-16-pre2
cvs
parents:
diff changeset
69 extern int pop_top_next _ARGS((popserver server, char **line));
05472e90ae02 Import from CVS: tag r19-16-pre2
cvs
parents:
diff changeset
70 extern int pop_top_flush _ARGS((popserver server));
05472e90ae02 Import from CVS: tag r19-16-pre2
cvs
parents:
diff changeset
71 extern int pop_multi_first _ARGS((popserver server, char *command,
05472e90ae02 Import from CVS: tag r19-16-pre2
cvs
parents:
diff changeset
72 char **response));
05472e90ae02 Import from CVS: tag r19-16-pre2
cvs
parents:
diff changeset
73 extern int pop_multi_next _ARGS((popserver server, char **line));
05472e90ae02 Import from CVS: tag r19-16-pre2
cvs
parents:
diff changeset
74 extern int pop_multi_flush _ARGS((popserver server));
05472e90ae02 Import from CVS: tag r19-16-pre2
cvs
parents:
diff changeset
75 extern int pop_delete _ARGS((popserver server, int message));
05472e90ae02 Import from CVS: tag r19-16-pre2
cvs
parents:
diff changeset
76 extern int pop_noop _ARGS((popserver server));
05472e90ae02 Import from CVS: tag r19-16-pre2
cvs
parents:
diff changeset
77 extern int pop_last _ARGS((popserver server));
05472e90ae02 Import from CVS: tag r19-16-pre2
cvs
parents:
diff changeset
78 extern int pop_reset _ARGS((popserver server));
05472e90ae02 Import from CVS: tag r19-16-pre2
cvs
parents:
diff changeset
79 extern int pop_quit _ARGS((popserver server));
05472e90ae02 Import from CVS: tag r19-16-pre2
cvs
parents:
diff changeset
80 extern void pop_close _ARGS((popserver));
05472e90ae02 Import from CVS: tag r19-16-pre2
cvs
parents:
diff changeset
81
05472e90ae02 Import from CVS: tag r19-16-pre2
cvs
parents:
diff changeset
82 #undef _ARGS