Category

Development Platform
Home > SourceCode/Document > Internet-Socket-Network > Browser Client > View Code
HTDescpt.h
Package: arena-beta-2b-src.tar.gz　[view]
Upload User: zlh9724
Upload Date: 2007-01-04
Package Size: 1991k
Code Size: 3k
Category:

Browser Client

Development Platform:

Unix_Linux

HTDescpt.h：Code Content
  1. /*                                                                          File descriptions
  2.                                     FILE DESCRIPTIONS
  3.                                              
  4.  */
  5. /*
  6. **      (c) COPYRIGHT MIT 1995.
  7. **      Please first read the full copyright statement in the file COPYRIGH.
  8. */
  9. /*
  11.    Descriptions appearing in directory listings are produced by this module. This may be
  12.    overridden by another module for those who which descriptions to come from somewhere
  13.    else. It's only HTTP directory listings that contain a description field (if enabled by
  14.    the Directory browsing module.
  15.    
  16.    This module is implemented by HTDescpt.c, and it is a part of the  W3C Reference
  17.    Library.
  18.    
  19.  */
  20. #ifndef HTDESCRIPT_H
  21. #define HTDESCRIPT_H
  23. /*
  25. Description File
  27.    This module gets descriptions from the file defined by global variable
  28.    HTDescriptionFile in the same directory as the directoy to be listed. The default value
  29.    is .www_descript:
  30.    
  31.  */
  32. extern char * HTDescriptionFile;
  33. /*
  35.    In the description file lines starting with a word starting with 'D' are taken to be
  36.    descriptions (this looks funny now, but this is to make it easy to extend these
  37.    description files to contain also other information. An example of the format of the
  38.    description file is:
  39.    
  40.  */
  41. /*
  42. **      DESCRIBE  welcome.html  Our welcome page
  43. **      DESCRIBE  map*.gif      Map as a GIF image
  44. **      DESCRIBE  map*.ps       Map as a PostScript image
  45. */
  46. /*
  48. HTML Titles
  50.    If description is not specified for a file that is of type text/html, this module uses
  51.    the HTML TITLE as the description.  This feature can be turned off by setting the
  52.    HTPeekTitles variable to false.
  53.    
  54.  */
  55. extern BOOL HTPeekTitles;
  56. /*
  58. Read Description File
  60.    The description file for a directory is read in only once by HTReadDescriptions(), and
  61.    the result returned by it is given as an argument when finding out a description for a
  62.    single file.
  63.    
  64.  */
  65. extern HTList * HTReadDescriptions (char * dirname);
  66. /*
  68. Get Description For a File
  70.    Once description file has been read and the list of descriptions is returned by
  71.    HTReadDescriptions(), the function HTGetDescription() can be used to get a description
  72.    for a given file:
  73.    
  74.  */
  75. extern char * HTGetDescription (HTList *        descriptions,
  76.                                        char *   dirname,
  77.                                        char *   filename,
  78.                                        HTFormat format);
  79. /*
  81.    Directory name has to be present because this function may then take a peek at the file
  82.    itself (to get the HTML TITLE, for example). If format is WWW_HTML and description is
  83.    not found, this module may be configured to use the HTML TITLE as the description.
  84.    
  85.    No string returned by this function should be freed!
  86.    
  87. Freeing Descriptions
  89.    Once descriptions have been gotten, the description list returned by
  90.    HTReadDescriptions() must be freed by HTFreeDescriptions():
  91.    
  92.  */
  93. extern void HTFreeDescriptions (HTList * descriptions);
  94. /*
  96.  */
  97. #endif /* !HTDESCRIPT_H */
  98. /*
  100.    End of HTDescpt.h. */