Annotation of libwww/Library/src/HTAlert.html, revision 2.53
2.6 timbl 1: <HTML>
2: <HEAD>
2.51 frystyk 3: <!-- Changed by: Henrik Frystyk Nielsen, 13-Jul-1996 -->
2.46 frystyk 4: <TITLE>W3C Sample Code Library libwww Library Alert Class</TITLE>
2.6 timbl 5: </HEAD>
6: <BODY>
2.38 frystyk 7: <H1>
8: The Alert Class
9: </H1>
2.12 frystyk 10: <PRE>
11: /*
2.18 frystyk 12: ** (c) COPYRIGHT MIT 1995.
2.12 frystyk 13: ** Please first read the full copyright statement in the file COPYRIGH.
14: */
15: </PRE>
2.38 frystyk 16: <P>
17: The Alert class defines a set of methods to be used by libwww to be used
18: for passing prompts and message to a user. In order to maintain the Library
19: core application independent and natural language independent, libwww does
20: not know how to communicate with a <I>user</I>. Note here that a <I>user</I>
21: is a somewhat abstract notion for something that can receive a message
22: or prompt from the Library. This can for example be a person, but is may
23: also be handled automatically by a robot or a client receiving a response
24: from a HTTP server.
25: <P>
26: Libwww has a set of <B>opcodes</B> that classifies the nature of the message,
27: for example that it is a question that must be confirmed in order to continue
28: a request or simply a progress notification. The application can register
29: a method for any number of the defined opcodes - in case the Library has
30: a message for an opcode that does not have a method associated, the message
31: is ignored. You can also globally disable any message send from the Library.
32: <P>
33: <B>Note</B>: The library <B>core</B> does not define any message or dialog
34: methods - they are all considered part of the application. The library comes
35: with a <A HREF="HTDialog.html">default set of methods</A> which can be initiated
36: using the function <CODE>HTAlertInit()</CODE> in <A HREF="HTInit.html">HTInit
37: module</A>
38: <P>
39: This module is implemented by <A HREF="HTAlert.c">HTAlert.c</A>, and it is
2.50 frystyk 40: a part of the <A HREF="http://www.w3.org/Library/"> W3C Sample Code
2.38 frystyk 41: Library</A>.
2.11 frystyk 42: <PRE>
2.12 frystyk 43: #ifndef HTALERT_H
44: #define HTALERT_H
2.17 frystyk 45:
2.27 frystyk 46: #include "HTReq.h"
2.11 frystyk 47: </PRE>
2.38 frystyk 48: <H2>
49: Message Opcodes and Messages
50: </H2>
51: <P>
52: The callback functions are defined as a generic callback where the caller
53: can pass a set of input parameters and the callee can return a set of outptu
54: parameters. Also note that all the <CODE>*_PROG_*</CODE> opcodes are a subset
55: of <CODE>HT_A_PROGRESS</CODE>. This means that you easily can register a
56: callback for <EM>all</EM> progress reports.
2.32 frystyk 57: <PRE>
58: typedef enum _HTAlertOpcode {
59: HT_PROG_DNS = 0x1, /* Doing DNS resolution */
60: HT_PROG_CONNECT = 0x2, /* Connecting Active */
61: HT_PROG_ACCEPT = 0x4, /* Connecting Passive */
62: HT_PROG_READ = 0x8, /* Read data */
63: HT_PROG_WRITE = 0x10, /* Write data */
64: HT_PROG_DONE = 0x20, /* Request finished */
2.53 ! frystyk 65: HT_PROG_INTERRUPT = 0x40, /* Request interrupted */
! 66: HT_PROG_OTHER = 0x80, /* Other progress notes */
! 67: HT_PROG_TIMEOUT = 0x100, /* Request timed out */
! 68: HT_A_PROGRESS = 0xFFFF, /* Get all progress reports - no reply */
2.32 frystyk 69:
70: /* First word are reserved for progresss notifications */
71:
2.53 ! frystyk 72: HT_A_MESSAGE = 0x1<<16, /* Send a message - no reply */
! 73: HT_A_CONFIRM = 0x2<<16, /* Want YES or NO back */
! 74: HT_A_PROMPT = 0x4<<16, /* Want full dialog */
! 75: HT_A_SECRET = 0x8<<16, /* Secret dialog (e.g. password) */
! 76: HT_A_USER_PW = 0x10<<16 /* Atomic userid and password */
2.32 frystyk 77: } HTAlertOpcode;
2.15 frystyk 78:
2.32 frystyk 79: typedef struct _HTAlertPar HTAlertPar;
2.8 luotonen 80:
2.32 frystyk 81: typedef BOOL HTAlertCallback (HTRequest * request, HTAlertOpcode op,
2.35 frystyk 82: int msgnum, const char * dfault, void * input,
2.32 frystyk 83: HTAlertPar * reply);
2.6 timbl 84: </PRE>
2.38 frystyk 85: <P>
86: If you don't expect any return values then <CODE>reply</CODE> can be NULL.
87: The return value of the callback function can be used to indicate confirmation
88: on a prompt (Yes or No).
89: <H3>
90: String Messages
91: </H3>
92: <P>
93: This is an enumerated list of messages that can be converted into a string
94: table etc.
2.15 frystyk 95: <PRE>
2.32 frystyk 96: typedef enum _HTAlertMsg {
97: HT_MSG_NULL = -1,
98: HT_MSG_UID = 0,
2.43 frystyk 99: HT_MSG_PROXY_UID,
100: HT_MSG_FTP_UID,
2.32 frystyk 101: HT_MSG_PW,
102: HT_MSG_FILENAME,
103: HT_MSG_ACCOUNT,
104: HT_MSG_METHOD,
105: HT_MSG_MOVED,
106: HT_MSG_RULES,
2.39 frystyk 107: HT_MSG_FILE_REPLACE,
108: HT_MSG_RETRY_AUTHENTICATION,
2.41 frystyk 109: HT_MSG_RETRY_PROXY_AUTH,
2.40 frystyk 110: HT_MSG_REDO,
111: HT_MSG_BIG_PUT,
112: HT_MSG_SOURCE_MOVED,
113: HT_MSG_DESTINATION_MOVED,
2.41 frystyk 114: HT_MSG_REDIRECTION,
2.47 frystyk 115: HT_MSG_PROXY,
2.48 frystyk 116: HT_MSG_CACHE_LOCK,
2.32 frystyk 117: HT_MSG_ELEMENTS /* This MUST be the last element */
118: } HTAlertMsg;
2.45 eric 119:
120: #define HT_MSG_ENGLISH_INITIALIZER \
121: "Please enter username:", \
122: "Please enter username for proxy authentication:", \
123: "Please enter username for this FTP server:", \
124: "Password:", \
125: "Please give name of file to save in:", \
126: "Plase enter account:", \
127: "You might not be allowed to use this method here, continue?", \
128: "Location has moved, continue?", \
2.47 frystyk 129: "A new set of rules is requested to be added to your setup - continue?", \
2.45 eric 130: "This file already exists - replace existing file?", \
131: "Authentication failed - retry?", \
132: "Proxy authentication failed - retry?", \
133: "This method has already been performed - repeat operation?", \
134: "This document is very big - continue operation?", \
135: "The source document for this operation has moved - continue operation \
136: with new location?", \
137: "The destination document for this operation has moved - continue \
138: operation with new location?", \
2.47 frystyk 139: "A redirection may change the behavior of this method - proceed anyway?", \
2.48 frystyk 140: "An automatic request for changing proxy has been encountered - continue?", \
141: "The persistent cache is already in use by another user. If this is not \
142: the case then you can manually delete this lock and restart."
2.15 frystyk 143: </PRE>
2.38 frystyk 144: <H2>
145: Enable or Disable Messages
146: </H2>
147: <P>
148: If you really don't want the library to prompt for anything at all then enable
149: this constant. The default value is <EM>Interactive</EM>.
2.32 frystyk 150: <PRE>
151: extern void HTAlert_setInteractive (BOOL interative);
152: extern BOOL HTAlert_interactive (void);
2.15 frystyk 153: </PRE>
2.38 frystyk 154: <H2>
155: Creation and Deletion Methods
156: </H2>
157: <P>
158: Message methods are registered in lists. By default a list is not enabled
159: before you assign it as being <I><A HREF="#active">active</A></I>. This allows
160: the application to maintain multiple lists of message handlers which can
161: be swapped in and out as neeeded.
162: <H3>
163: Add a Callback Function
164: </H3>
165: <P>
166: Register a call back function that is to be called when generating messages,
167: dialog, prompts, progress reports etc. The opcode signifies which call back
168: function to call depending of the type of the message. Opcode can be any
169: combination of the bitflags defined by <CODE>HTAlertOpcode</CODE>. If you
170: register one callback for <CODE>HT_A_PROGRESS </CODE>then this will get called
171: on all progress notifications.
2.15 frystyk 172: <PRE>
2.32 frystyk 173: extern BOOL HTAlertCall_add (HTList * list, HTAlertCallback * cbf,
174: HTAlertOpcode opcode);
2.15 frystyk 175: </PRE>
2.38 frystyk 176: <H3>
177: Delete a Callback function
178: </H3>
179: <P>
2.32 frystyk 180: Unregister a call back function from a list
2.8 luotonen 181: <PRE>
2.32 frystyk 182: extern BOOL HTAlertCall_delete (HTList * list, HTAlertCallback * cbf);
2.15 frystyk 183: </PRE>
2.38 frystyk 184: <H3>
2.51 frystyk 185: Delete all Callbacks With this Opcode
186: </H3>
187: <P>
188: Unregister all handlers registered for a given opcode.
189: <PRE>
190: extern BOOL HTAlertCall_deleteOpcode (HTList * list, HTAlertOpcode opcode);
191: </PRE>
192: <H3>
2.38 frystyk 193: Delete a list of Callback Functions
194: </H3>
195: <P>
2.32 frystyk 196: Unregisters all call back functions
197: <PRE>
198: extern BOOL HTAlertCall_deleteAll (HTList * list);
199: </PRE>
2.38 frystyk 200: <H3>
201: Find a Callback Function
202: </H3>
203: <P>
204: Finds a callback function corresponding to the opcode. If none has been
205: registered then NULL is returned.
2.6 timbl 206: <PRE>
2.32 frystyk 207: extern HTAlertCallback * HTAlertCall_find(HTList * list, HTAlertOpcode opcode);
2.6 timbl 208: </PRE>
2.38 frystyk 209: <H2>
210: The Reply Object
211: </H2>
212: <P>
213: The reply object is used for communicating input from the <I>user</I> back
214: to the Library. This is only required to use when for example the user is
215: prompted for a file name etc. You can find several examples on how to use
216: this in the <A HREF="HTDialog.html">default message and dialog module</A>
217: provided together with the Library.
218: <PRE>extern HTAlertPar * HTAlert_newReply (void);
2.32 frystyk 219: extern void HTAlert_deleteReply (HTAlertPar * old);
220: </PRE>
2.38 frystyk 221: <H3>
222: Handle the Reply Message
223: </H3>
224: <P>
225: These methods provide the API for handling the reply message. There are two
226: ways of assigning a message to the reply message - either by copying the
227: buffer or by reusing the same buffer. In the latter case, the caller must
228: make sure <B>not</B> to free the reply message before it has been used.
2.34 frystyk 229: <PRE>
2.35 frystyk 230: extern BOOL HTAlert_setReplyMessage (HTAlertPar * me, const char *message);
2.34 frystyk 231: extern BOOL HTAlert_assignReplyMessage (HTAlertPar * me, char * message);
232: </PRE>
2.38 frystyk 233: <P>
2.34 frystyk 234: You can get the data back again by using this method:
2.32 frystyk 235: <PRE>
236: extern char * HTAlert_replyMessage (HTAlertPar * me);
2.34 frystyk 237: </PRE>
238: <PRE>
2.32 frystyk 239: extern char * HTAlert_replySecret (HTAlertPar * me);
2.35 frystyk 240: extern BOOL HTAlert_setReplySecret (HTAlertPar * me, const char * secret);
2.6 timbl 241:
2.32 frystyk 242: extern void * HTAlert_replyOutput (HTAlertPar * me);
243: extern BOOL HTAlert_setReplyOutput (HTAlertPar * me, void * output);
2.17 frystyk 244: </PRE>
2.38 frystyk 245: <H2>
246: <A NAME="active">Active set of Callback Functions</A>
247: </H2>
248: <P>
249: A list can be assigned as being active in which case it is <I>visible</I>
2.51 frystyk 250: for libwww by assigning the list as the <I>global alert list</I>. Libwww
251: does not know about inactive lists of alert handlers.
2.32 frystyk 252: <PRE>
253: extern void HTAlert_setGlobal (HTList * list);
254: extern HTList * HTAlert_global (void);
255: </PRE>
2.51 frystyk 256: <H3>
257: Global Alert List Methods
258: </H3>
2.38 frystyk 259: <P>
2.51 frystyk 260: You can assign a callback directly to the global list in which case it becomes
261: immediately available to libwww. In this case you do not need to worry about
262: creating the list - it will be created as well as deleted automatically.
263: <H4>
264: Add an Alert Handler
265: </H4>
266: <PRE>
267: extern BOOL HTAlert_add (HTAlertCallback * cbf, HTAlertOpcode opcode);
268: </PRE>
269: <H4>
270: Delete an Alert Handler
271: </H4>
272: <P>
273: You can either delete a handler by referring to its address or to the opcode
274: that it has been registered for.
275: <PRE>
276: extern BOOL HTAlert_delete (HTAlertCallback * cbf);
277: extern BOOL HTAlert_deleteOpcode (HTAlertOpcode opcode);
278: </PRE>
279: <H4>
280: Delete all Alert Handlers
281: </H4>
2.17 frystyk 282: <PRE>
2.49 frystyk 283: extern BOOL HTAlert_deleteAll (void);
2.51 frystyk 284: </PRE>
285: <H4>
286: Find an Alert Handler
287: </H4>
288: <PRE>
2.32 frystyk 289: extern HTAlertCallback * HTAlert_find (HTAlertOpcode opcode);
290: </PRE>
291: <PRE>
2.12 frystyk 292: #endif
293: </PRE>
2.38 frystyk 294: <P>
295: <HR>
2.37 frystyk 296: <ADDRESS>
2.53 ! frystyk 297: @(#) $Id: HTAlert.html,v 2.52 1998/07/09 17:05:09 frystyk Exp $
2.37 frystyk 298: </ADDRESS>
2.38 frystyk 299: </BODY></HTML>
Webmaster
![[BACK]](/cvsweb/icons/back.gif){kind=icon}
Return to HTAlert.html CVS log ![[TXT]](/cvsweb/icons/text.gif){kind=icon}
![[DIR]](/cvsweb/icons/dir.gif){kind=icon}
Up to [Public] / libwww / Library / src