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