./ROBODocSource/items.h

ItemLineKind

FUNCTION

Holds the type of an item line

SOURCE

enum ItemLineKind
{
    ITEM_LINE_RAW,              /* A line that does not start with a remark marker */
    ITEM_LINE_PLAIN,            /* A line that starts with a remark marker */
    ITEM_LINE_PIPE,             /* A line that starts with a remark marked and is
                                   followed by a pipe marker. */
    ITEM_LINE_END,              /* The last line of an item */

    ITEM_LINE_TOOL_START,       /* Start line of a tool item */
    ITEM_LINE_TOOL_BODY,        /* Body of a tool item */
    ITEM_LINE_TOOL_END,         /* End line of a tool item */
    ITEM_LINE_EXEC,             /* Exec item */
    ITEM_LINE_DOT_START,        /* Similar to TOOL_START but use DOT tool */
    ITEM_LINE_DOT_END,          /* End line of a DOT item */
    ITEM_LINE_DOT_FILE          /* DOT file to include */
};

ItemTypes

[ Top ] [ Items ] [ Types ]

NAME

ItemTypes -- enumeration of item types

FUNCTION

Defines a number of item types. There are two kind of items:

the SOURCE item which is always available,
and items defined by the user (or through the default items).

NOTES

Never check an item type against SOURCECODE_ITEM directily! Use Works_Like_SourceItem() function instead.

SOURCE

enum ItemType
{ POSSIBLE_ITEM = -2, NO_ITEM = -1, SOURCECODE_ITEM = 0, OTHER_ITEM };

RB_Item

[ Top ] [ Items ] [ Structures ]

FUNCTION

Keeps track of where items start end end in the header. The index numbers point to the lines array in RB_header.

SOURCE

struct RB_Item
{
    struct RB_Item     *next;
    enum ItemType       type;
    int                 no_lines;
    struct RB_Item_Line **lines;
    int                 begin_index;
    int                 end_index;
    int                 max_line_number;
};

RB_Item_Line

[ Top ] [ Items ] [ Structures ]

FUNCTION

Holds the attributes and the content of an item line

ATTRIBUTES

line -- The contents of the item line
kind -- The type of the line (see: ItemLineKind)
format -- Formatting attributes for the line
pipe_mode -- The output mode
line_number -- The original source line number of the line

SOURCE

struct RB_Item_Line
{
    char               *line;
    enum ItemLineKind   kind;
    long                format;
    T_RB_DocType        pipe_mode;
    int                 line_number;
};