annotate netinstall/netio.h @ 4502:8748a3f7ceb4

Handle varalias chains, custom variables in #'user-variable-p. src/ChangeLog addition: 2008-08-23 Aidan Kehoe <kehoea@parhasard.net> * eval.c (Fuser_variable_p): Moved to symbols.c * symbols.c (Fcustom_variable_p): Moved here from custom.el. (user_variable_alias_check_fun): Mapper function used in `user-variable-p'. (Fuser_variable_p): Moved here from eval.c, to allow it to examine the variable alias chain. Expanded to check each entry in the variable alias chain for signs of being a user variable; documentation updated, noting the differences between GNU's behaviour and ours (ours is a little more sensible) (map_varalias_chain): New. Given a C function, call it at least once for each symbol in a symbol's varalias chain, signalling an error if there's a cycle, and returning immediately if the function returns something other than Qzero. (Fdefvaralias): Correct the use of the word "alias" in the docstring and in the argument name. Motivate this in a comment. Add support for a DOCSTRING argument, something GNU has too, and document this * gc.c (vars_of_gc): Start the docstring of `garbage-collection-messages' with an asterisk, to indicate that it's a user variable. lisp/ChangeLog addition: 2008-08-23 Aidan Kehoe <kehoea@parhasard.net> * custom.el: Move #'custom-variable-p to C, since it's now called from #'user-variable-p.
author Aidan Kehoe <kehoea@parhasard.net>
date Sat, 23 Aug 2008 16:38:51 +0200
parents 3078fd1074e8
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
448
3078fd1074e8 Import from CVS: tag r21-2-39
cvs
parents:
diff changeset
1 /*
3078fd1074e8 Import from CVS: tag r21-2-39
cvs
parents:
diff changeset
2 * Copyright (c) 2000, Red Hat, Inc.
3078fd1074e8 Import from CVS: tag r21-2-39
cvs
parents:
diff changeset
3 *
3078fd1074e8 Import from CVS: tag r21-2-39
cvs
parents:
diff changeset
4 * This program is free software; you can redistribute it and/or modify
3078fd1074e8 Import from CVS: tag r21-2-39
cvs
parents:
diff changeset
5 * it under the terms of the GNU General Public License as published by
3078fd1074e8 Import from CVS: tag r21-2-39
cvs
parents:
diff changeset
6 * the Free Software Foundation; either version 2 of the License, or
3078fd1074e8 Import from CVS: tag r21-2-39
cvs
parents:
diff changeset
7 * (at your option) any later version.
3078fd1074e8 Import from CVS: tag r21-2-39
cvs
parents:
diff changeset
8 *
3078fd1074e8 Import from CVS: tag r21-2-39
cvs
parents:
diff changeset
9 * A copy of the GNU General Public License can be found at
3078fd1074e8 Import from CVS: tag r21-2-39
cvs
parents:
diff changeset
10 * http://www.gnu.org/
3078fd1074e8 Import from CVS: tag r21-2-39
cvs
parents:
diff changeset
11 *
3078fd1074e8 Import from CVS: tag r21-2-39
cvs
parents:
diff changeset
12 * Written by DJ Delorie <dj@cygnus.com>
3078fd1074e8 Import from CVS: tag r21-2-39
cvs
parents:
diff changeset
13 *
3078fd1074e8 Import from CVS: tag r21-2-39
cvs
parents:
diff changeset
14 */
3078fd1074e8 Import from CVS: tag r21-2-39
cvs
parents:
diff changeset
15
3078fd1074e8 Import from CVS: tag r21-2-39
cvs
parents:
diff changeset
16 /* This is the parent class for all the access methods known to setup
3078fd1074e8 Import from CVS: tag r21-2-39
cvs
parents:
diff changeset
17 (i.e. ways to download files from the internet or other sources */
3078fd1074e8 Import from CVS: tag r21-2-39
cvs
parents:
diff changeset
18
3078fd1074e8 Import from CVS: tag r21-2-39
cvs
parents:
diff changeset
19 class NetIO {
3078fd1074e8 Import from CVS: tag r21-2-39
cvs
parents:
diff changeset
20 protected:
3078fd1074e8 Import from CVS: tag r21-2-39
cvs
parents:
diff changeset
21 NetIO (char *url);
3078fd1074e8 Import from CVS: tag r21-2-39
cvs
parents:
diff changeset
22 void set_url (char *url);
3078fd1074e8 Import from CVS: tag r21-2-39
cvs
parents:
diff changeset
23
3078fd1074e8 Import from CVS: tag r21-2-39
cvs
parents:
diff changeset
24 public:
3078fd1074e8 Import from CVS: tag r21-2-39
cvs
parents:
diff changeset
25 /* if nonzero, this is the estimated total file size */
3078fd1074e8 Import from CVS: tag r21-2-39
cvs
parents:
diff changeset
26 int file_size;
3078fd1074e8 Import from CVS: tag r21-2-39
cvs
parents:
diff changeset
27 /* broken down url FYI */
3078fd1074e8 Import from CVS: tag r21-2-39
cvs
parents:
diff changeset
28 char *url;
3078fd1074e8 Import from CVS: tag r21-2-39
cvs
parents:
diff changeset
29 char *proto;
3078fd1074e8 Import from CVS: tag r21-2-39
cvs
parents:
diff changeset
30 char *host;
3078fd1074e8 Import from CVS: tag r21-2-39
cvs
parents:
diff changeset
31 int port;
3078fd1074e8 Import from CVS: tag r21-2-39
cvs
parents:
diff changeset
32 char *path;
3078fd1074e8 Import from CVS: tag r21-2-39
cvs
parents:
diff changeset
33 virtual ~NetIO ();
3078fd1074e8 Import from CVS: tag r21-2-39
cvs
parents:
diff changeset
34
3078fd1074e8 Import from CVS: tag r21-2-39
cvs
parents:
diff changeset
35 /* The user calls this function to create a suitable accessor for
3078fd1074e8 Import from CVS: tag r21-2-39
cvs
parents:
diff changeset
36 the given URL. It uses the network setup state in state.h. If
3078fd1074e8 Import from CVS: tag r21-2-39
cvs
parents:
diff changeset
37 anything fails, either the return values is NULL or the returned
3078fd1074e8 Import from CVS: tag r21-2-39
cvs
parents:
diff changeset
38 object is !ok() */
3078fd1074e8 Import from CVS: tag r21-2-39
cvs
parents:
diff changeset
39 static NetIO * open (char *url);
3078fd1074e8 Import from CVS: tag r21-2-39
cvs
parents:
diff changeset
40
3078fd1074e8 Import from CVS: tag r21-2-39
cvs
parents:
diff changeset
41 /* If !ok() that means the transfer isn't happening. */
3078fd1074e8 Import from CVS: tag r21-2-39
cvs
parents:
diff changeset
42 virtual int ok ();
3078fd1074e8 Import from CVS: tag r21-2-39
cvs
parents:
diff changeset
43
3078fd1074e8 Import from CVS: tag r21-2-39
cvs
parents:
diff changeset
44 /* Read `nbytes' bytes from the file. Returns zero when the file
3078fd1074e8 Import from CVS: tag r21-2-39
cvs
parents:
diff changeset
45 is complete. */
3078fd1074e8 Import from CVS: tag r21-2-39
cvs
parents:
diff changeset
46 virtual int read (char *buf, int nbytes);
3078fd1074e8 Import from CVS: tag r21-2-39
cvs
parents:
diff changeset
47
3078fd1074e8 Import from CVS: tag r21-2-39
cvs
parents:
diff changeset
48 /* Helper functions for http/ftp protocols. Both return nonzero for
3078fd1074e8 Import from CVS: tag r21-2-39
cvs
parents:
diff changeset
49 "cancel", zero for "ok". They set net_proxy_user, etc, in
3078fd1074e8 Import from CVS: tag r21-2-39
cvs
parents:
diff changeset
50 state.h */
3078fd1074e8 Import from CVS: tag r21-2-39
cvs
parents:
diff changeset
51 int get_auth ();
3078fd1074e8 Import from CVS: tag r21-2-39
cvs
parents:
diff changeset
52 int get_proxy_auth ();
3078fd1074e8 Import from CVS: tag r21-2-39
cvs
parents:
diff changeset
53 };