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