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