util/robodoc/Source/items.h

   1
   2
   3
   4 #ifndef ROBODOC_ITEMS_H
   5 #define ROBODOC_ITEMS_H
   6
   7 enum
   8   {
   9     MAKE_NORMAL = -1, MAKE_LARGE, MAKE_ITALICS, MAKE_NON_PROP, MAKE_SMALL,
  10     MAKE_BOLD, MAKE_UNDERLINE, MAKE_SHINE, MAKE_HIGH, SIZE_ATTRIBUTES
  11   };
  12
  13 #define ITEM_NAME_LARGE_FONT (1<<0)
  14 #define TEXT_BODY_LARGE_FONT (1<<(MAKE_LARGE     + 1))
  15 #define TEXT_BODY_ITALICS    (1<<(MAKE_ITALICS   + 1))
  16 #define TEXT_BODY_NON_PROP   (1<<(MAKE_NON_PROP  + 1))
  17 #define TEXT_BODY_SMALL_FONT (1<<(MAKE_SMALL     + 1))
  18 #define TEXT_BODY_BOLD       (1<<(MAKE_BOLD      + 1))
  19 #define TEXT_BODY_UNDERLINE  (1<<(MAKE_UNDERLINE + 1))
  20 #define TEXT_BODY_SHINE      (1<<(MAKE_SHINE     + 1))
  21 #define TEXT_BODY_HIGHLIGHT  (1<<(MAKE_HIGH      + 1))
  22
  23
  24 /****** ROBODoc/ItemTypes *
  25  * NAME
  26  *   ItemTypes -- enumeration of item types
  27  * FUNCTION
  28  *   Give an unique number to each item type. This defines all item types that
  29  *   are recognized by ROBODoc. The corresponding names (string) of each item
  30  *   are defined in item_names.  If you add an item here you also should
  31  *   add an corresponding item name.
  32  * SOURCE
  33  */
  34
  35 enum
  36   {
  37     NO_ITEM = 0,
  38     NAME_ITEM,
  39     COPYRIGHT_ITEM,
  40     SYNOPSIS_ITEM, USAGE_ITEM,
  41     FUNCTION_ITEM, DESCRIPTION_ITEM, PURPOSE_ITEM,
  42     AUTHOR_ITEM,
  43     CREATION_DATE_ITEM,
  44     MODIFICATION_HISTORY_ITEM, HISTORY_ITEM,
  45     INPUT_ITEM, ARGUMENT_ITEM, OPTION_ITEM, PARAMETER_ITEM, SWITCH_ITEM,
  46     OUTPUT_ITEM, SIDE_EFFECTS_ITEM,
  47     RESULT_ITEM, RETURN_VALUE_ITEM,
  48     EXAMPLE_ITEM,
  49     NOTE_ITEM,
  50     DIAGNOSTICS_ITEM,
  51     WARNING_ITEM, ERROR_ITEM,
  52     BUGS_ITEM,
  53     TODO_ITEM, IDEAS_ITEM,
  54     PORTABILITY_ITEM,
  55     SEE_ALSO_ITEM,
  56     SOURCE_ITEM,
  57     METHODS_ITEM, NEW_METHODS_ITEM,
  58     ATTRIBUTES_ITEM, NEW_ATTRIBUTES_ITEM,
  59     TAGS_ITEM,
  60     COMMANDS_ITEM,
  61     DERIVED_FROM_ITEM,
  62     DERIVED_BY_ITEM,
  63     USES_ITEM, CHILDREN_ITEM,
  64     USED_BY_ITEM, PARENTS_ITEM,
  65     OTHER_ITEM,
  66     NUMBER_OF_ITEMS
  67   };
  68
  69 /****/
  70
  71 extern char *item_names[];
  72 extern long item_attributes[NUMBER_OF_ITEMS];
  73 extern char *item_attr_names[];
  74 extern char *att_start_command[SIZE_ATTRIBUTES][SIZE_MODES];
  75 extern char *att_stop_command[SIZE_ATTRIBUTES][SIZE_MODES];
  76
  77 int RB_Get_Item_Type (char *);
  78 int RB_Get_Item_Attr (char *cmp_name);
  79
  80
  81 #endif /* ROBODOC_ITEMS_H */