Category

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

Browser Client

Development Platform:

Unix_Linux

HTHist.h：Code Content
  1. /*                                                                             History module
  2.                                      HISTORY MANAGER
  3.                                              
  4.  */
  5. /*
  6. **      (c) COPYRIGHT MIT 1995.
  7. **      Please first read the full copyright statement in the file COPYRIGH.
  8. */
  9. /*
  11.    This is a simple history module for a WWW client.  It keeps a linear history, with a
  12.    destructive or non-destructive backtrack, and list sequencing (previous, next)
  13.    operations.
  14.    
  15.    If you are building a client, you don't have to use this: just don't call it.  This
  16.    module is not used by any other modules in the libwww, so if you don't refer to it you
  17.    don't get it in your linked application.
  18.    
  19.    This module is implemented by HTHist.c, and it is a part of the W3C Reference Library.
  20.    
  21.  */
  22. #ifndef HTHISTORY_H
  23. #define HTHISTORY_H
  25. #include "HTAnchor.h"
  26. /*
  28. Creation and Deletion Methods
  30.    The history module can handle multiple history lists which can be useful in a
  31.    multithreaded environment with several open windows in the client application. A new
  32.    histrory lidt is referenced by the handle returned from the creation method.
  33.    
  34.  */
  35. typedef struct _HTHistory HTHistory;
  37. extern HTHistory *HTHistory_new         (void);
  38. extern BOOL HTHistory_delete            (HTHistory *old);
  39. /*
  41. Add and delete History Elements
  43.   RECORD AN ENTRY IN A LIST
  44.   
  45.    Registers the object in the linear list. The first entry is the home page. No check is
  46.    done for duplicates.  Returns YES if ok, else NO
  47.    
  48.  */
  49. extern BOOL HTHistory_record            (HTHistory *hist, HTAnchor *cur);
  50. /*
  52.   REPLACE LIST WITH NEW ELEMENT
  53.   
  54.    Iserts the new element at the current position and removes all any old list from
  55.    current position. For example if c is cur pos
  56.    
  57.       before: a b c d e
  58.       
  59.       after : a b f
  60.       
  61.    Returns YES if ok, else NO
  62.    
  63.  */
  64. extern BOOL HTHistory_replace           (HTHistory *hist, HTAnchor *cur);
  65. /*
  67.   DELETE LAST ENTRY IN A LIST
  68.   
  69.    Deletes the last object from the list Returns YES if OK, else NO
  70.    
  71.  */
  72. extern BOOL HTHistory_removeLast        (HTHistory *hist);
  73. /*
  75.   REMOVE THE HISTORY LIST FROM POSITION
  76.   
  77.    Deletes the history list FROM the entry at position 'cur' (excluded). Home page has
  78.    position 1.  Returns YES if OK, else NO
  79.    
  80.  */
  81. extern BOOL HTHistory_removeFrom        (HTHistory *hist, int pos);
  82. /*
  84.   NUMBER OF ELEMENTS STORED
  85.   
  86.    Returns the size of the history list or -1 if none.
  87.    
  88.  */
  89. extern int HTHistory_count              (HTHistory *hist);
  90. /*
  92.   CURRENT POSITION
  93.   
  94.    Returns the current position or -1 on error
  95.    
  96.  */
  97. extern int HTHistory_position           (HTHistory *hist);
  98. /*
  100.   FIND AND RE-REGISTER VISITED ANCHOR
  101.   
  102.    Finds already registered anchor at given position and registers it again EXCEPT if last
  103.    entry. This allows for `circular' history lists with duplicate entries. Position 1 is
  104.    the home anchor. The current position is updated.
  105.    
  106.  */
  107. extern HTAnchor * HTHistory_recall      (HTHistory *hist, int pos);
  108. /*
  110.   FIND ENTRY AT POSITION
  111.   
  112.    Entry with the given index in the list (1 is the home page). Like HTHistory_recall but
  113.    without re-registration. Un success, the current position is updated to the value 'pos'
  114.    value.
  115.    
  116.  */
  117. extern HTAnchor * HTHistory_find        (HTHistory *hist, int pos);
  118. /*
  120.   LIST THE HISTORY LIST
  121.   
  122.    This function is like HTHistory_find() but does not update the current position
  123.    
  124.  */
  125. extern HTAnchor * HTHistory_list        (HTHistory *hist, int pos);
  126. /*
  128. Navigation
  130.   CAN WE BACK IN HISTORY
  131.   
  132.    Returns YES if the current anchor is not the first entry (home page)
  133.    
  134.  */
  135. extern BOOL HTHistory_canBacktrack      (HTHistory *hist);
  136. /*
  138.   BACKTRACK WITH DELETION
  139.   
  140.    Returns the previous object and erases the last object. This does not allow for
  141.    'forward' as we are always at the end of the list. If no previous object exists, NULL
  142.    is returned so that the application knows that no previous object was found. See also
  143.    HTHistory_back().
  144.    
  145.  */
  146. extern HTAnchor * HTHistory_backtrack   (HTHistory *hist);
  147. /*
  149.   BACKTRACK WITHOUT DELETION
  150.   
  151.    Returns the previos object but does not erase the last object. This does not allow for
  152.    'forward'. If no previous object exists, NULL is returned so that the application knows
  153.    that no previous object was found. See also HTHistory_backtrack()
  154.    
  155.  */
  156. extern HTAnchor * HTHistory_back        (HTHistory *hist);
  157. /*
  159.   CAN WE GO FORWARD
  160.   
  161.    Returns YES if the current anchor is not the last entry
  162.    
  163.  */
  164. extern BOOL HTHistory_canForward        (HTHistory *hist);
  165. /*
  167.   FORWARD
  168.   
  169.    Return the next object in the list or NULL if none
  170.    
  171.  */
  172. extern HTAnchor * HTHistory_forward     (HTHistory *hist);
  174. #endif /* HTHISTORY_H */
  175. /*
  177.     */