Annotation of Amaya/amaya/amaya.h, revision 1.81
1.8 cvs 1: /*
2: *
3: * (c) COPYRIGHT MIT and INRIA, 1996.
4: * Please first read the full copyright statement in file COPYRIGHT.
5: *
6: */
7:
1.59 cvs 8: #ifndef AMAYA_H
1.1 cvs 9: #define AMAYA_H
10:
1.10 cvs 11: /* Thot interface */
1.81 ! cvs 12: #include "ustring.h"
1.10 cvs 13: #include "thot_gui.h"
14: #include "thot_sys.h"
1.79 cvs 15: #include "appstruct.h"
1.10 cvs 16: #include "application.h"
17: #include "attribute.h"
18: #include "browser.h"
19: #include "content.h"
20: #include "dialog.h"
21: #include "interface.h"
22: #include "libmsg.h"
23: #include "message.h"
24: #include "presentation.h"
25: #include "selection.h"
26: #include "reference.h"
27: #include "tree.h"
28: #include "view.h"
29:
1.1 cvs 30: /* Included headerfiles */
1.10 cvs 31: #include "EDITOR.h"
1.1 cvs 32: #include "HTML.h"
33: #include "amayamsg.h"
34:
1.25 cvs 35: #define MAX_LENGTH 512
36: #define NAME_LENGTH 32
37: #define HTAppName "amaya"
1.77 cvs 38: #define HTAppVersion "V1.5"
1.25 cvs 39:
1.36 cvs 40: #define URL_SEP '/'
41: #define URL_STR "/"
42:
1.50 cvs 43: /* The structures used for request callbacks */
44:
45: typedef void TIcbf (Document doc, int status, char *urlName,
46: char *outputfile, const char *content_type,
47: const char *data_block, int data_block_size,
48: void *context);
49:
50: typedef void TTcbf (Document doc, int status, char *urlName,
51: char *outputfile, const char *content_type,
52: void *context);
53:
1.25 cvs 54: /* How are Network accesses provided ? */
55: #ifdef AMAYA_JAVA
56: #include "libjava.h"
57: #else
1.39 cvs 58: #ifdef AMAYA_ILU
59: #include "libilu.h"
60: #else
1.25 cvs 61: #include "libwww.h"
62: #endif
1.39 cvs 63: #endif
1.1 cvs 64:
1.66 cvs 65: /* The different events to open a new document */
1.41 cvs 66: typedef enum _ClickEvent {
1.73 cvs 67: CE_ABSOLUTE, CE_RELATIVE, CE_FORM_POST, CE_FORM_GET,
68: CE_HELP, CE_MAKEBOOK, CE_LOG
1.41 cvs 69: } ClickEvent;
1.20 cvs 70:
71: #define NO 0
72: #define YES 1
73:
74: /* dialogue */
75: #define URLForm 1
1.29 cvs 76: #define OpenForm 2
77: #define URLName 3
78: #define LocalName 4
79: #define DirSelect 5
80: #define DocSelect 6
1.20 cvs 81: #define StopCommand 7
1.29 cvs 82: #define SaveForm 8
1.20 cvs 83: #define DirSave 9
84: #define DocSave 10
85: #define ToggleSave 11
1.29 cvs 86: #define NameSave 12
1.30 cvs 87: #define ImgDirSave 13
88: #define Label1 14
89: #define Label2 15
90: #define Label3 16
91: #define Label4 17
1.29 cvs 92: #define ConfirmForm 18
93: #define ConfirmText 19
1.20 cvs 94: #define AttrHREFForm 20
95: #define AttrHREFText 21
96: #define FormAnswer 22
97: #define AnswerText 24
98: #define NameText 25
99: #define PasswordText 26
1.30 cvs 100: #define FilterText 27
101: #define ClassForm 28
1.20 cvs 102: #define ClassSelect 29
103: #define AClassForm 30
1.30 cvs 104: #define AClassSelect 31
105: #define ConfirmSave 32
106: #define ConfirmSaveList 33
107: #define OptionMenu 34
1.69 cvs 108: #define MAX_SUBMENUS 20
109: /* MAX_SUBMENUS references reserved for submenus of Option menu */
110: #define About1 55
111: #define About2 56
112: #define About3 57
113: #define Version 58
1.70 cvs 114: #define AboutForm 59
115: #define CSSForm 60
1.69 cvs 116: #define CSSSelect 61
1.70 cvs 117: #define TableForm 62
118: #define TableRows 63
119: #define TableCols 64
120: #define TableBorder 65
121: #define MAX_REF 66
1.20 cvs 122:
1.11 cvs 123: /* The possible GET/POST/PUT request modes */
1.1 cvs 124:
1.11 cvs 125: /*synchronous request*/
126: #define AMAYA_SYNC 1 /*0x000001 */
127: /*synchronous request with incremental callbacks */
128: #define AMAYA_ISYNC 2 /*0x000010 */
129: /*asynchronous request */
1.5 cvs 130: #define AMAYA_ASYNC 4 /*0x000100 */
1.11 cvs 131: /*asynchronous request with incremental callbacks */
1.5 cvs 132: #define AMAYA_IASYNC 8 /*0x001000 */
1.11 cvs 133: /* send the form using the POST HTTP method */
1.5 cvs 134: #define AMAYA_FORM_POST 16 /*0x010000 */
1.11 cvs 135: /* send the form using the GET HTTP method */
1.5 cvs 136: #define AMAYA_FORM_GET 32 /*0x100000 */
1.23 cvs 137: /* bypass caching */
138: #define AMAYA_NOCACHE 64
139: /* don't follow redirections */
140: #define AMAYA_NOREDIR 128
1.48 cvs 141: #ifndef AMAYA_JAVA
142: /* Prevents a stop race condition in ASYNC transfers */
143: #define AMAYA_ASYNC_SAFE_STOP 256
1.60 cvs 144: #define AMAYA_LOAD_CSS 512
1.67 cvs 145: #define AMAYA_FLUSH_REQUEST 1024
1.80 cvs 146: #define AMAYA_USE_PRECONDITIONS 2048
1.63 cvs 147: #else
148: #define AMAYA_ASYNC_SAFE_STOP 0
149: #define AMAYA_LOAD_CSS 0
1.80 cvs 150: #define AMAYA_USE_PRECONDITIONS 0
1.48 cvs 151: #endif /* ! AMAYA_JAVA */
1.26 cvs 152: /*
153: * Flags to indicate the status of the network requests associated
154: * to a document.
155: */
156:
157: #define AMAYA_NET_INACTIVE 1
158: #define AMAYA_NET_ERROR 2
159: #define AMAYA_NET_ACTIVE 4
160:
1.25 cvs 161: /*
162: * Flags for HTParse, specifying which parts of the URL are needed
163: */
164: #define AMAYA_PARSE_ACCESS 16 /* Access scheme, e.g. "HTTP" */
165: #define AMAYA_PARSE_HOST 8 /* Host name, e.g. "www.w3.org" */
166: #define AMAYA_PARSE_PATH 4 /* URL Path, e.g. "pub/WWW/TheProject.html" */
167: #define AMAYA_PARSE_ANCHOR 2 /* Fragment identifier, e.g. "news" */
168: #define AMAYA_PARSE_PUNCTUATION 1 /* Include delimiters, e.g, "/" and ":" */
169: #define AMAYA_PARSE_ALL 31 /* All the parts */
1.1 cvs 170:
1.14 cvs 171: THOT_EXPORT int appArgc;
172: THOT_EXPORT char **appArgv;
173: THOT_EXPORT char TempFileDirectory[MAX_LENGTH];
174: THOT_EXPORT char Answer_text[MAX_LENGTH];
175: THOT_EXPORT char Answer_name[NAME_LENGTH];
176: THOT_EXPORT char Answer_password[NAME_LENGTH];
177: THOT_EXPORT char Display_password[NAME_LENGTH];
1.30 cvs 178: THOT_EXPORT char ScanFilter[NAME_LENGTH]; /* to scan directories */
1.14 cvs 179: THOT_EXPORT char *LastURLName; /* last URL requested */
180: THOT_EXPORT char *DirectoryName; /* local path of the document */
181: THOT_EXPORT char *DocumentName; /* document name */
1.43 cvs 182: THOT_EXPORT char *SavePath; /* saving path */
183: THOT_EXPORT char *SaveName; /* saving name of the document */
1.30 cvs 184: THOT_EXPORT char *ObjectName; /* document name */
1.14 cvs 185: THOT_EXPORT char *SaveImgsURL; /* where to save remote Images */
186: THOT_EXPORT char *TargetName;
1.45 cvs 187: THOT_EXPORT char *SavingFile; /* complete path or URL of the document */
188: THOT_EXPORT int Lg_password;
189: THOT_EXPORT int BaseDialog;
1.14 cvs 190: THOT_EXPORT int ReturnOption;
1.70 cvs 191: THOT_EXPORT int NumberRows;
192: THOT_EXPORT int NumberCols;
193: THOT_EXPORT int TBorder;
1.69 cvs 194: THOT_EXPORT int ReturnOptionMenu;
1.14 cvs 195: THOT_EXPORT Document CurrentDocument;
196: THOT_EXPORT Document SavingDocument;
197: THOT_EXPORT Document SavingObject;
198: THOT_EXPORT Document AttrHREFdocument;
1.45 cvs 199: THOT_EXPORT Document DocBook;
200: THOT_EXPORT Document IncludedDocument;
1.14 cvs 201: THOT_EXPORT Element AttrHREFelement;
202: THOT_EXPORT char *AttrHREFvalue;
203: THOT_EXPORT Document SelectionDoc;
1.45 cvs 204: THOT_EXPORT boolean SaveAsHTML;
1.62 cvs 205: THOT_EXPORT boolean SaveAsXML;
1.45 cvs 206: THOT_EXPORT boolean SaveAsText;
207: THOT_EXPORT boolean CopyImages; /* should we copy images in Save As */
208: THOT_EXPORT boolean UpdateURLs; /* should we update URLs in Save As */
209: THOT_EXPORT boolean UserAnswer;
210: THOT_EXPORT boolean InNewWindow;
1.14 cvs 211: THOT_EXPORT boolean SelectionInPRE;
212: THOT_EXPORT boolean SelectionInComment;
213: THOT_EXPORT boolean SelectionInEM;
214: THOT_EXPORT boolean SelectionInSTRONG;
215: THOT_EXPORT boolean SelectionInCITE;
1.56 cvs 216: THOT_EXPORT boolean SelectionInABBR;
217: THOT_EXPORT boolean SelectionInACRONYM;
1.57 cvs 218: THOT_EXPORT boolean SelectionInINS;
219: THOT_EXPORT boolean SelectionInDEL;
1.14 cvs 220: THOT_EXPORT boolean SelectionInDFN;
221: THOT_EXPORT boolean SelectionInCODE;
222: THOT_EXPORT boolean SelectionInVAR;
223: THOT_EXPORT boolean SelectionInSAMP;
224: THOT_EXPORT boolean SelectionInKBD;
225: THOT_EXPORT boolean SelectionInI;
226: THOT_EXPORT boolean SelectionInB;
227: THOT_EXPORT boolean SelectionInTT;
228: THOT_EXPORT boolean SelectionInBIG;
229: THOT_EXPORT boolean SelectionInSMALL;
1.53 cvs 230: typedef enum
231: {
232: docHTML,
1.75 cvs 233: docReadOnly,
1.74 cvs 234: docText,
1.75 cvs 235: docImage,
236: docImageRO
1.53 cvs 237: } DocumentType;
1.64 cvs 238:
239:
240: /* a record for data associated with a request */
241: typedef struct _DocumentMetaDataElement
242: {
243: char *form_data; /* form data associated with a URL */
244: ClickEvent method; /* method used to send this data */
245: } DocumentMetaDataElement;
246:
1.1 cvs 247: #define DocumentTableLength 10
1.14 cvs 248: THOT_EXPORT char *DocumentURLs[DocumentTableLength];
1.64 cvs 249: /* Any formdata associated with a URL */
250: THOT_EXPORT DocumentMetaDataElement *DocumentMeta[DocumentTableLength];
1.41 cvs 251: /* TRUE if the document is displayed by help commands */
1.53 cvs 252: THOT_EXPORT DocumentType DocumentTypes[DocumentTableLength];
1.1 cvs 253: /* The whole document is loaded when the corresponding value
254: in FilesLoading is equal to 0 */
1.14 cvs 255: THOT_EXPORT int FilesLoading[DocumentTableLength];
1.26 cvs 256: /* Gives the status (error, success) of the download of the objects of
257: a document */
1.42 cvs 258:
1.26 cvs 259: THOT_EXPORT int DocNetworkStatus[DocumentTableLength];
1.14 cvs 260: THOT_EXPORT Document W3Loading; /* the document being loaded */
1.65 cvs 261: THOT_EXPORT Document BackupDocument; /* the current backup */
1.14 cvs 262: THOT_EXPORT int IButton;
263: THOT_EXPORT int BButton;
264: THOT_EXPORT int TTButton;
1.5 cvs 265:
1.64 cvs 266: #define IMAGE_NOT_LOADED 0
1.1 cvs 267: #define IMAGE_LOCAL 1
268: #define IMAGE_LOADED 2
269: #define IMAGE_MODIFIED 3
270:
1.27 cvs 271: #ifdef __STDC__
1.41 cvs 272: typedef void (*LoadedImageCallback)(Document doc, Element el, char *file, void *extra);
1.27 cvs 273: #else
274: typedef void (*LoadedImageCallback)();
275: #endif
1.5 cvs 276: typedef struct _ElemImage
277: {
1.27 cvs 278: Element currentElement;/* first element using this image */
1.5 cvs 279: struct _ElemImage *nextElement;
1.27 cvs 280: LoadedImageCallback callback; /* Callback for non-standard handling */
281: void *extra; /* any extra info for the CallBack */
1.5 cvs 282: }
283: ElemImage;
284:
285: typedef struct _LoadedImageDesc
286: {
1.58 cvs 287: char *originalName; /* complete URL of the image */
1.5 cvs 288: char *localName; /* local name (without path) of the image */
1.58 cvs 289: struct _LoadedImageDesc *prevImage;/* double linked list */
290: struct _LoadedImageDesc *nextImage;/* easier to unchain */
291: Document document; /* document concerned */
292: struct _ElemImage *elImage; /* first element using this image */
293: int imageType; /* the type of the image */
294: int status; /* the status of the image loading */
1.5 cvs 295: }
296: LoadedImageDesc;
297:
1.14 cvs 298: THOT_EXPORT LoadedImageDesc *ImageURLs;
1.31 cvs 299: THOT_EXPORT LoadedImageDesc *ImageLocal;
1.1 cvs 300:
1.72 cvs 301: #define BROWSING 0
302: #define SELECTING 1
303: #define SEARCHING 2
304: #define VIEWS 3
305: #define CREATING 4
306: #define LINKS 5
307: #define CHANGING 6
308: #define TABLES 7
309: #define MATH 8
310: #define IMAGEMAPS 9
311: #define CSS 10
312: #define ATTRIBUTES 11
313: #define SPELLCHECKING 12
314: #define PUBLISHING 13
315: #define PRINTING 14
316: #define NUMBERING 15
317: #define MAKEBOOK 16
318: #define CONFIGURE 17
319:
1.25 cvs 320: #endif /* AMAYA_H */
1.48 cvs 321:
322:
323:
324:
325:
326:
327:
328:
329:
330:
1.1 cvs 331:
Webmaster