util/robodoc/Source/links.h

   1
   2
   3 #ifndef ROBODOC_LINKS_H
   4 #define ROBODOC_LINKS_H
   5
   6 /****s* ROBODoc/RB_link [2.0e]
   7  *  NAME
   8  *    RB_link -- link data structure
   9  *  PURPOSE
  10  *    Structure to store links to the documentation of an component.
  11  *  PROPERTIES
  12  *    next_link
  13  *    prev_link
  14  *    label_name  -- the label under which the component can be found.
  15  *    file_name   -- the file the component can be found in.
  16  *    type        -- the type of component (the header type).
  17  *  SOURCE
  18  */
  19
  20 struct RB_link
  21   {
  22     struct RB_link *next_link;
  23     struct RB_link *prev_link;
  24     char *label_name;
  25     char *file_name;
  26     int type;
  27   };
  28
  29 /*********/
  30
  31 extern FILE *xreffiles_file;
  32 extern FILE *xref_file;
  33 extern int link_index_size;
  34 extern struct RB_link **link_index;
  35
  36 void RB_Analyse_Xrefs (FILE * xreffiles_file);
  37 void RB_Add_Link ();
  38 void RB_Generate_xrefs (FILE * dest_doc, char *source_name, char *dest_name);
  39 int RB_Find_Link (char *word_begin, char **label_name, char **file_name);
  40 struct RB_link *RB_Alloc_Link (char *label_name, char *file_name);
  41 void RB_Free_Link (struct RB_link *link);
  42 void RB_Slow_Sort_Links (void);
  43
  44 #endif /* ROBODOC_LINKS_H */