Annotation of Amaya/amaya/amaya.h, revision 1.127
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 */
12: #include "thot_gui.h"
13: #include "thot_sys.h"
1.79 cvs 14: #include "appstruct.h"
1.10 cvs 15: #include "application.h"
16: #include "attribute.h"
17: #include "browser.h"
18: #include "content.h"
19: #include "dialog.h"
1.103 cvs 20: #include "fileaccess.h"
1.10 cvs 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"
1.105 cvs 29: #include "uconvert.h"
1.82 cvs 30: #include "undo.h"
1.1 cvs 31: /* Included headerfiles */
1.10 cvs 32: #include "EDITOR.h"
1.1 cvs 33: #include "HTML.h"
1.84 cvs 34: #include "TextFile.h"
1.1 cvs 35: #include "amayamsg.h"
36:
1.25 cvs 37: #define MAX_LENGTH 512
38: #define NAME_LENGTH 32
39:
1.108 cvs 40: #define HTAppName TEXT ("amaya")
1.126 cvs 41: #define HTAppVersion TEXT ("V2.5")
1.125 cvs 42: #define HTAppDate TEXT ("17 Dec 1999")
1.108 cvs 43: #define URL_STR TEXT ("/")
44: #define URL_SEP TEXT ('/')
1.105 cvs 45:
1.36 cvs 46:
1.94 cvs 47: /* Number of views used in Amaya */
48: #define AMAYA_MAX_VIEW_DOC 7
49:
1.50 cvs 50: /* The structures used for request callbacks */
51:
52: typedef void TIcbf (Document doc, int status, char *urlName,
53: char *outputfile, const char *content_type,
54: const char *data_block, int data_block_size,
55: void *context);
56:
1.105 cvs 57: typedef void TTcbf (Document doc, int status, STRING urlName,
58: STRING outputfile, const STRING content_type,
1.50 cvs 59: void *context);
60:
1.25 cvs 61: /* How are Network accesses provided ? */
62: #ifdef AMAYA_JAVA
63: #include "libjava.h"
64: #else
1.39 cvs 65: #ifdef AMAYA_ILU
66: #include "libilu.h"
67: #else
1.25 cvs 68: #include "libwww.h"
69: #endif
1.39 cvs 70: #endif
1.1 cvs 71:
1.66 cvs 72: /* The different events to open a new document */
1.41 cvs 73: typedef enum _ClickEvent {
1.73 cvs 74: CE_ABSOLUTE, CE_RELATIVE, CE_FORM_POST, CE_FORM_GET,
1.127 ! cvs 75: CE_HELP, CE_MAKEBOOK, CE_LOG , CE_TEMPLATE, CE_INIT
! 76: #ifdef ANNOTATIONS
! 77: ,CE_ANNOT
! 78: #endif /* ANNOTATIONS */
1.41 cvs 79: } ClickEvent;
1.20 cvs 80:
81: #define NO 0
82: #define YES 1
83:
84: /* dialogue */
85: #define URLForm 1
1.29 cvs 86: #define OpenForm 2
87: #define URLName 3
88: #define LocalName 4
89: #define DirSelect 5
90: #define DocSelect 6
1.20 cvs 91: #define StopCommand 7
1.29 cvs 92: #define SaveForm 8
1.20 cvs 93: #define DirSave 9
94: #define DocSave 10
95: #define ToggleSave 11
1.29 cvs 96: #define NameSave 12
1.30 cvs 97: #define ImgDirSave 13
98: #define Label1 14
99: #define Label2 15
100: #define Label3 16
101: #define Label4 17
1.29 cvs 102: #define ConfirmForm 18
103: #define ConfirmText 19
1.20 cvs 104: #define AttrHREFForm 20
105: #define AttrHREFText 21
106: #define FormAnswer 22
1.120 cvs 107: #define RealmText 23
1.20 cvs 108: #define AnswerText 24
109: #define NameText 25
110: #define PasswordText 26
1.30 cvs 111: #define FilterText 27
112: #define ClassForm 28
1.20 cvs 113: #define ClassSelect 29
114: #define AClassForm 30
1.30 cvs 115: #define AClassSelect 31
116: #define ConfirmSave 32
117: #define ConfirmSaveList 33
118: #define OptionMenu 34
1.91 cvs 119: #define MAX_SUBMENUS 400
1.69 cvs 120: /* MAX_SUBMENUS references reserved for submenus of Option menu */
1.91 cvs 121: #define About1 435
122: #define About2 436
123: #define About3 437
124: #define Version 438
125: #define AboutForm 439
1.92 cvs 126: #define TableForm 440
127: #define TableRows 441
128: #define TableCols 442
129: #define TableBorder 443
130: #define MAX_REF 444
1.20 cvs 131:
1.11 cvs 132: /* The possible GET/POST/PUT request modes */
1.1 cvs 133:
1.11 cvs 134: /*synchronous request*/
135: #define AMAYA_SYNC 1 /*0x000001 */
136: /*synchronous request with incremental callbacks */
137: #define AMAYA_ISYNC 2 /*0x000010 */
138: /*asynchronous request */
1.5 cvs 139: #define AMAYA_ASYNC 4 /*0x000100 */
1.11 cvs 140: /*asynchronous request with incremental callbacks */
1.5 cvs 141: #define AMAYA_IASYNC 8 /*0x001000 */
1.11 cvs 142: /* send the form using the POST HTTP method */
1.5 cvs 143: #define AMAYA_FORM_POST 16 /*0x010000 */
1.11 cvs 144: /* send the form using the GET HTTP method */
1.5 cvs 145: #define AMAYA_FORM_GET 32 /*0x100000 */
1.23 cvs 146: /* bypass caching */
147: #define AMAYA_NOCACHE 64
148: /* don't follow redirections */
149: #define AMAYA_NOREDIR 128
1.48 cvs 150: #ifndef AMAYA_JAVA
151: /* Prevents a stop race condition in ASYNC transfers */
152: #define AMAYA_ASYNC_SAFE_STOP 256
1.60 cvs 153: #define AMAYA_LOAD_CSS 512
1.67 cvs 154: #define AMAYA_FLUSH_REQUEST 1024
1.80 cvs 155: #define AMAYA_USE_PRECONDITIONS 2048
1.123 cvs 156: #define AMAYA_LOAD_IMAGE 4096
157:
1.63 cvs 158: #else
159: #define AMAYA_ASYNC_SAFE_STOP 0
160: #define AMAYA_LOAD_CSS 0
1.80 cvs 161: #define AMAYA_USE_PRECONDITIONS 0
1.48 cvs 162: #endif /* ! AMAYA_JAVA */
1.87 cvs 163:
164: /*
165: * Flags to indicate the action to take when the network options
166: * are modified
167: */
168: #define AMAYA_CACHE_RESTART 1
169: #define AMAYA_PROXY_RESTART 2
1.114 cvs 170: #define AMAYA_LANNEG_RESTART 4
171: #define AMAYA_SAFEPUT_RESTART 8
1.87 cvs 172:
1.26 cvs 173: /*
174: * Flags to indicate the status of the network requests associated
175: * to a document.
176: */
177:
178: #define AMAYA_NET_INACTIVE 1
179: #define AMAYA_NET_ERROR 2
180: #define AMAYA_NET_ACTIVE 4
181:
1.25 cvs 182: /*
183: * Flags for HTParse, specifying which parts of the URL are needed
184: */
185: #define AMAYA_PARSE_ACCESS 16 /* Access scheme, e.g. "HTTP" */
186: #define AMAYA_PARSE_HOST 8 /* Host name, e.g. "www.w3.org" */
187: #define AMAYA_PARSE_PATH 4 /* URL Path, e.g. "pub/WWW/TheProject.html" */
188: #define AMAYA_PARSE_ANCHOR 2 /* Fragment identifier, e.g. "news" */
189: #define AMAYA_PARSE_PUNCTUATION 1 /* Include delimiters, e.g, "/" and ":" */
190: #define AMAYA_PARSE_ALL 31 /* All the parts */
1.1 cvs 191:
1.14 cvs 192: THOT_EXPORT int appArgc;
1.105 cvs 193: THOT_EXPORT STRING *appArgv;
194: THOT_EXPORT CHAR_T TempFileDirectory[MAX_LENGTH];
195: THOT_EXPORT CHAR_T Answer_text[MAX_LENGTH];
196: THOT_EXPORT CHAR_T Answer_name[NAME_LENGTH];
197: THOT_EXPORT CHAR_T Answer_password[NAME_LENGTH];
198: THOT_EXPORT CHAR_T Display_password[NAME_LENGTH];
199: THOT_EXPORT CHAR_T ScanFilter[NAME_LENGTH]; /* to scan directories */
200: THOT_EXPORT STRING LastURLName; /* last URL requested */
201: THOT_EXPORT STRING DirectoryName; /* local path of the document */
202: THOT_EXPORT STRING DocumentName; /* document name */
203: THOT_EXPORT STRING SavePath; /* saving path */
204: THOT_EXPORT STRING SaveName; /* saving name of the document */
205: THOT_EXPORT STRING ObjectName; /* document name */
206: THOT_EXPORT STRING SaveImgsURL; /* where to save remote Images */
207: THOT_EXPORT STRING TargetName;
208: THOT_EXPORT STRING SavingFile; /* complete path or URL of the document */
1.45 cvs 209: THOT_EXPORT int Lg_password;
210: THOT_EXPORT int BaseDialog;
1.14 cvs 211: THOT_EXPORT int ReturnOption;
1.70 cvs 212: THOT_EXPORT int NumberRows;
213: THOT_EXPORT int NumberCols;
214: THOT_EXPORT int TBorder;
1.69 cvs 215: THOT_EXPORT int ReturnOptionMenu;
1.14 cvs 216: THOT_EXPORT Document CurrentDocument;
217: THOT_EXPORT Document SavingDocument;
218: THOT_EXPORT Document SavingObject;
219: THOT_EXPORT Document AttrHREFdocument;
1.45 cvs 220: THOT_EXPORT Document DocBook;
221: THOT_EXPORT Document IncludedDocument;
1.14 cvs 222: THOT_EXPORT Element AttrHREFelement;
1.95 cvs 223: THOT_EXPORT STRING AttrHREFvalue;
1.14 cvs 224: THOT_EXPORT Document SelectionDoc;
1.113 cvs 225: THOT_EXPORT ThotBool IsNewAnchor;
1.115 cvs 226: THOT_EXPORT ThotBool UseLastTarget;
1.116 cvs 227: THOT_EXPORT ThotBool LinkAsCSS;
1.98 cvs 228: THOT_EXPORT ThotBool SaveAsHTML;
229: THOT_EXPORT ThotBool SaveAsXHTML;
230: THOT_EXPORT ThotBool SaveAsText;
231: THOT_EXPORT ThotBool CopyImages; /* should we copy images in Save As */
232: THOT_EXPORT ThotBool UpdateURLs; /* should we update URLs in Save As */
233: THOT_EXPORT ThotBool UserAnswer;
234: THOT_EXPORT ThotBool InNewWindow;
235: THOT_EXPORT ThotBool SelectionInPRE;
236: THOT_EXPORT ThotBool SelectionInComment;
237: THOT_EXPORT ThotBool SelectionInEM;
238: THOT_EXPORT ThotBool SelectionInSTRONG;
239: THOT_EXPORT ThotBool SelectionInCITE;
240: THOT_EXPORT ThotBool SelectionInABBR;
241: THOT_EXPORT ThotBool SelectionInACRONYM;
242: THOT_EXPORT ThotBool SelectionInINS;
243: THOT_EXPORT ThotBool SelectionInDEL;
244: THOT_EXPORT ThotBool SelectionInDFN;
245: THOT_EXPORT ThotBool SelectionInCODE;
246: THOT_EXPORT ThotBool SelectionInVAR;
247: THOT_EXPORT ThotBool SelectionInSAMP;
248: THOT_EXPORT ThotBool SelectionInKBD;
249: THOT_EXPORT ThotBool SelectionInI;
250: THOT_EXPORT ThotBool SelectionInB;
251: THOT_EXPORT ThotBool SelectionInTT;
252: THOT_EXPORT ThotBool SelectionInBIG;
253: THOT_EXPORT ThotBool SelectionInSMALL;
1.100 cvs 254: THOT_EXPORT ThotBool SelectionInSub;
255: THOT_EXPORT ThotBool SelectionInSup;
256: THOT_EXPORT ThotBool SelectionInQuote;
257: THOT_EXPORT ThotBool SelectionInBDO;
1.108 cvs 258: THOT_EXPORT ThotBool HTMLErrorsFound;
1.100 cvs 259:
1.53 cvs 260: typedef enum
261: {
262: docHTML,
1.110 cvs 263: docHTMLRO,
1.74 cvs 264: docText,
1.84 cvs 265: docTextRO,
1.75 cvs 266: docImage,
1.85 cvs 267: docImageRO,
268: docCSS,
1.110 cvs 269: docCSSRO,
270: docSource,
1.127 ! cvs 271: docSourceRO,
! 272: #ifdef ANNOTATIONS
! 273: docAnnot,
! 274: docAnnotRO
! 275: #endif /* ANNOTATIONS */
1.53 cvs 276: } DocumentType;
1.64 cvs 277:
278:
279: /* a record for data associated with a request */
280: typedef struct _DocumentMetaDataElement
281: {
1.105 cvs 282: STRING form_data; /* form data associated with a URL */
1.64 cvs 283: ClickEvent method; /* method used to send this data */
1.124 cvs 284: ThotBool put_default_name; /* URL name was concatenated with DEFAULT_NAME */
285: ThotBool xmlformat; /* the document should be exported in xml format */
1.64 cvs 286: } DocumentMetaDataElement;
287:
1.1 cvs 288: #define DocumentTableLength 10
1.110 cvs 289: /* URL of each loaded document */
1.105 cvs 290: THOT_EXPORT STRING DocumentURLs[DocumentTableLength];
1.64 cvs 291: /* Any formdata associated with a URL */
292: THOT_EXPORT DocumentMetaDataElement *DocumentMeta[DocumentTableLength];
1.110 cvs 293: /* Type of document */
1.53 cvs 294: THOT_EXPORT DocumentType DocumentTypes[DocumentTableLength];
1.110 cvs 295: /* identifier of the document displaying the source code */
296: THOT_EXPORT Document DocumentSource[DocumentTableLength];
297: /* The whole document is loaded when the corresponding entry in FilesLoading is 0 */
1.14 cvs 298: THOT_EXPORT int FilesLoading[DocumentTableLength];
1.110 cvs 299: /* Status (error, success) of the download of the objects of a document */
300: THOT_EXPORT int DocNetworkStatus[DocumentTableLength];
1.42 cvs 301:
1.14 cvs 302: THOT_EXPORT Document W3Loading; /* the document being loaded */
1.65 cvs 303: THOT_EXPORT Document BackupDocument; /* the current backup */
1.104 cvs 304:
305: /* button indexes */
306: THOT_EXPORT int iStop;
307: THOT_EXPORT int iBack;
308: THOT_EXPORT int iForward;
309: THOT_EXPORT int iReload;
310: THOT_EXPORT int iHome;
311: THOT_EXPORT int iEditor;
312: THOT_EXPORT int iSave;
313: THOT_EXPORT int iPrint;
314: THOT_EXPORT int iFind;
315: THOT_EXPORT int iI;
316: THOT_EXPORT int iB;
317: THOT_EXPORT int iT;
318: THOT_EXPORT int iImage;
319: THOT_EXPORT int iH1;
320: THOT_EXPORT int iH2;
321: THOT_EXPORT int iH3;
322: THOT_EXPORT int iBullet;
323: THOT_EXPORT int iNum;
324: THOT_EXPORT int iDL;
325: THOT_EXPORT int iLink;
326: THOT_EXPORT int iTable;
1.5 cvs 327:
1.64 cvs 328: #define IMAGE_NOT_LOADED 0
1.1 cvs 329: #define IMAGE_LOCAL 1
330: #define IMAGE_LOADED 2
331: #define IMAGE_MODIFIED 3
332:
1.109 cvs 333:
1.27 cvs 334: #ifdef __STDC__
1.109 cvs 335: typedef void (*LoadedImageCallback)(Document doc, Element el, char *file, void *extra);
1.27 cvs 336: #else
337: typedef void (*LoadedImageCallback)();
338: #endif
1.109 cvs 339:
1.5 cvs 340: typedef struct _ElemImage
341: {
1.27 cvs 342: Element currentElement;/* first element using this image */
1.5 cvs 343: struct _ElemImage *nextElement;
1.27 cvs 344: LoadedImageCallback callback; /* Callback for non-standard handling */
345: void *extra; /* any extra info for the CallBack */
1.5 cvs 346: }
347: ElemImage;
348:
349: typedef struct _LoadedImageDesc
350: {
1.105 cvs 351: STRING originalName; /* complete URL of the image */
352: STRING localName; /* local name (without path) of the image */
1.58 cvs 353: struct _LoadedImageDesc *prevImage;/* double linked list */
354: struct _LoadedImageDesc *nextImage;/* easier to unchain */
355: Document document; /* document concerned */
356: struct _ElemImage *elImage; /* first element using this image */
357: int imageType; /* the type of the image */
358: int status; /* the status of the image loading */
1.5 cvs 359: }
360: LoadedImageDesc;
1.109 cvs 361:
362: /* the structure used for storing the context of the
363: FetchAndDisplayImages_callback function */
364: typedef struct _FetchImage_context {
365: STRING base_url;
366: LoadedImageDesc *desc;
367: } FetchImage_context;
368:
1.5 cvs 369:
1.14 cvs 370: THOT_EXPORT LoadedImageDesc *ImageURLs;
1.31 cvs 371: THOT_EXPORT LoadedImageDesc *ImageLocal;
1.1 cvs 372:
1.88 cvs 373: /* The default Amaya HOME pages (page shown at boot time */
374:
1.105 cvs 375: #if defined(_I18N_) || defined(__JIS__)
376: # ifdef _WINDOWS
377: # define AMAYA_PAGE L"\\amaya\\AmayaPage.html"
378: # else /* _WINDOWS */
379: # define AMAYA_PAGE L"/amaya/AmayaPage.html"
380: # endif /* _WINDOWS */
381: # define AMAYA_PAGE_DOC L"http://www.w3.org/Amaya/User/"
382: #else /* !_I18N_ */
383: # ifdef _WINDOWS
384: # define AMAYA_PAGE "\\amaya\\AmayaPage.html"
385: # else /* _WINDOWS */
386: # define AMAYA_PAGE "/amaya/AmayaPage.html"
387: # endif /* _WINDOWS */
388: # define AMAYA_PAGE_DOC "http://www.w3.org/Amaya/User/"
389: #endif /* !_I18N_ */
1.88 cvs 390:
1.25 cvs 391: #endif /* AMAYA_H */
Webmaster