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