TABLE OF CONTENTS


    BFS_FILESYSTEM/BFS_SystemName
    BFS_FILESYSTEM/BFS_UserName
    BFS_FILESYSTEM/BFS_UserPassword
    BST_bits_System/BTF_Attributes
    BST_bits_System/BTF_Ignore
    BST_bits_System/BTF_UserTag
    BST_bits_Types/BTA_type_CString
    BST_bits_Types/BTA_type_Flags
    BST_bits_Types/BTA_type_Object
    BST_bits_Types/BTA_type_Plain
    BST_bits_Types/BTA_type_Pointer
    BST_bits_Types/BTA_type_TagList
    BTA_CONTROL/BTA_NumberOf
    BTA_IDENTIFIER/BTA_ClassName
    BTA_IDENTIFIER/BTA_FromObject
    BTA_IDENTIFIER/BTA_MainObject
    BTA_IDENTIFIER/BTA_Method
    BTA_IDENTIFIER/BTA_Object1
    BTA_IDENTIFIER/BTA_TagList
    BTA_IDENTIFIER/BTA_Title
    BTA_IDENTIFIER/BTA_ToObject
    BTA_POSITION/BTA_Height
    BTA_POSITION/BTA_Size
    BTA_POSITION/BTA_Width
    BTA_POSITION/BTA_X
    BTA_POSITION/BTA_Y
    BTA_SYSTEM/BTA_MemBlock
    BTA_SYSTEM/BTA_MemFlags
    BTA_SYSTEM/BTA_MemHandle
    BTA_SYSTEM/BTA_MemSize
    BTA_SYSTEM/BTA_Message
    BTA_SYSTEM/BTA_MsgPort
    BTA_SYSTEM/BTA_Signals
    BTA_SYSTEM/BTA_Signals_AND
    BTA_SYSTEM/BTA_Signals_OR
    BTA_SYSTEM/BTA_Signals_XOR
    BTA_TYPES/BTA_Flags
    BTA_TYPES/BTA_LongNumber
    TagLists/BST_bits_Family
    TagLists/BST_bits_System
    TagLists/BST_bits_Types
    TagLists/TagLists
    Tags/BFS_FILESYSTEM
    Tags/BTA_CONTROL
    Tags/BTA_IDENTIFIER
    Tags/BTA_POSITION
    Tags/BTA_SYSTEM
    Tags/BTA_TYPES

BFS_FILESYSTEM/BFS_SystemName

NAME
          BFS_SystemName -- BTA_type_CString. (under construction)
FUNCTION
          Pointer to the system Hostname. Used by the BFS_SystemClass.
EXAMPLE
          BFS_SystemClass

BFS_FILESYSTEM/BFS_UserName

NAME
          BFS_User -- BTA_type_CString. (V1 Bravo)
FUNCTION
          Pointer to the username. Mainly used by the BFS_UserClass.
EXAMPLE
          BFS_UserClass, mth_SetAttr_User

BFS_FILESYSTEM/BFS_UserPassword

NAME
          BFS_UserPassword -- BTA_type_CString. (V1 Bravo)
FUNCTION
          Pointer to the users password. Mainly used by the BFS_UserClass.
EXAMPLE
          BFS_UserClass, mth_SetAttr_User

BST_bits_System/BTF_Attributes

NAME
          BTF_Attributes -- (V1 Alpha)
FUNCTION
          This bit is set at all Beast attributes. (under construction)

BST_bits_System/BTF_Ignore

NAME
          BTF_Ignore -- (V1 Alpha)
FUNCTION
          This bit indicates that this tag should be ignored.
          This bit is often use to indicate that a certain tag has 'done it's job'.
          Because only a bit is used, the 'old' value of the tag can be simply
          retrieved by removing this flag again.
SEE ALSO
          OBM_SETATTR, OBM_GETATTR

BST_bits_System/BTF_UserTag

NAME
          BTF_UserTag -- (V1 Alpha)
FUNCTION
          Set this bit when you are defining your own tags, special caution must
          be taken doing so, because there can easily occur a conflict.

BST_bits_Types/BTA_type_CString

NAME
          BTA_type_CString -- (V1 Alpha)
FUNCTION
          Tag points to a C-type string which ends on a zero byte.

BST_bits_Types/BTA_type_Flags

NAME
          BTA_type_Flags -- (V1 Bravo)
FUNCTION
          The Tag values are flags.

BST_bits_Types/BTA_type_Object

NAME
          BTA_type_Object -- (V1 Alpha)
FUNCTION
          Pointer to a BEAST object.

BST_bits_Types/BTA_type_Plain

NAME
          BTA_type_Plain -- (V1 Alpha)
FUNCTION
          Just zero, so doesn't have to be added, the type of the tag is plain
          or undefined.

BST_bits_Types/BTA_type_Pointer

NAME
          BTA_type_Pointer -- (V1 Bravo)
FUNCTION
          Pointer to a structure/record/memory...etc.

BST_bits_Types/BTA_type_TagList

NAME
          BTA_type_TagList -- (V1 Bravo)
FUNCTION
          Pointer to a TagList. An TagList always ends with TAG_DONE.

BTA_CONTROL/BTA_NumberOf

NAME
          BTA_NumberOf -- BTA_type_Plain (V1 Alpha)
FUNCTION
          Contains the number of tags which must be processed.
          E.g. the OBM_SETATTR and OBM_GETATTR methods are using this tag.

BTA_IDENTIFIER/BTA_ClassName

NAME
          BTA_ClassName -- BTA_type_CString. (V1 Bravo)
FUNCTION
          Tag contains the pointer to a string which contains the
          name of the/a class. This string is read-only!
EXAMPLE
          The BST_BaseClass has implemented this tag.

BTA_IDENTIFIER/BTA_FromObject

NAME
          BTA_FromObject -- BTA_type_Object. (V1 Charlie)
FUNCTION
          Is used to indicate the 'FromObject'.

BTA_IDENTIFIER/BTA_MainObject

NAME
          BTA_MainObject -- BTA_type_Object (V1 Alpha)
FUNCTION
          Mostly used to point to the owner of a resource.. TagList..etc.
EXAMPLE
          See the OBM_FOREACH method.

BTA_IDENTIFIER/BTA_Method

NAME
          BTA_Method -- BTA_type_Plain. (V1 Bravo)
FUNCTION
          The Tag contains a BEAST Method number.
EXAMPLE
          See the OBM_FOREACH method.

BTA_IDENTIFIER/BTA_Object1

NAME
          BTA_Object1 -- BTA_type_Object. (V1 Bravo)
FUNCTION
          General Object tag, free for interpretation.
          Also the tags BTA_Object2 .. BTA_Object9 are available.

BTA_IDENTIFIER/BTA_TagList

NAME
          BTA_TagList -- BTA_type_TagList. (V1 Bravo)
FUNCTION
          The Tag contains a pointer to a generic TagList.
EXAMPLE
          See the OBM_SEARCHOBJECT method (BST_SearchClass).

BTA_IDENTIFIER/BTA_Title

NAME
          BTA_Title -- BTA_type_CString (V1 Alpha)
FUNCTION
          The Title of an object.
EXAMPLE
          See BST_BaseClass

BTA_IDENTIFIER/BTA_ToObject

NAME
          BTA_ToObject -- BTA_type_Object. (V1 Charlie)
FUNCTION
          Is used to indicate the 'ToObject'. For an example
          see mth_Copy_BaseClass.

BTA_POSITION/BTA_Height

NAME
          BTA_Height -- BTA_type_Plain (V1 Alpha)
FUNCTION
          Height, free for object's interpretation.

BTA_POSITION/BTA_Size

NAME
          BTA_Size -- BTA_type_Plain (V1 Bravo)
FUNCTION
          Size, free for object's interpretation.

BTA_POSITION/BTA_Width

NAME
          BTA_Width -- BTA_type_Plain (V1 Alpha)
FUNCTION
          Width, free for object's interpretation.

BTA_POSITION/BTA_X

NAME
          BTA_X -- BTA_type_Plain (V1 Alpha)
FUNCTION
          X position, free for object's interpretation.

BTA_POSITION/BTA_Y

NAME
          BTA_Y -- BTA_type_Plain (V1 Alpha)
FUNCTION
          Y position, free for object's interpretation.

BTA_SYSTEM/BTA_MemBlock

NAME
          BTA_MemBlock -- BTA_type_Pointer. (V1 Bravo)
FUNCTION
          The tag value points to a memory block, defined by a
          OBM_LOCKMEM method.
EXAMPLE
          BST_MemoryClass, mth_LockMem_BeastLibrary

BTA_SYSTEM/BTA_MemFlags

NAME
          BTA_MemFlags -- BTA_type_Flags. (V1 Bravo)
FUNCTION
          The tag value are the memory flags of a memory handle/block.
          See mth_AllocMem_BeastLibrary for the usage of the flags.
EXAMPLE
          BST_MemoryClass, mth_AllocMem_BeastLibrary

BTA_SYSTEM/BTA_MemHandle

NAME
          BTA_MemHandle -- BTA_type_Pointer. (V1 Bravo)
FUNCTION
          The tag value points to a memory block handle, defined by a
          OBM_ALLOCMEM method.
EXAMPLE
          BST_MemoryClass, mth_AllocMem_BeastLibrary

BTA_SYSTEM/BTA_MemSize

NAME
          BTA_MemSize -- BTA_type_Plain. (V1 Bravo)
FUNCTION
          The tag value is the size of the memory block in bytes.
          See mth_AllocMem_BeastLibrary.
EXAMPLE
          BST_MemoryClass, mth_AllocMem_BeastLibrary

BTA_SYSTEM/BTA_Message

NAME
          BTA_Message -- BTA_type_Pointer. (V1 Bravo)
FUNCTION
          Pointer to a Intuition Message structure
EXAMPLE
          BST_ApplicationClass, mth_AddEvent_Application, OBM_ADDEVENT

BTA_SYSTEM/BTA_MsgPort

NAME
          BTA_MsgPort -- BTA_type_Pointer. (V1 Bravo)
FUNCTION
          Pointer to a Intuition Message port.
EXAMPLE
          BST_ApplicationClass, mth_AddEvent_Application, OBM_ADDEVENT

BTA_SYSTEM/BTA_Signals

NAME
          BTA_Signals -- BTA_type_Flags. (V1 Bravo)
FUNCTION
          Signaling flags.
EXAMPLE
          BST_ApplicationClass, mth_SetAttr_Application, OBM_ADDEVENT

BTA_SYSTEM/BTA_Signals_AND

NAME
          BTA_Signals_AND -- BTA_type_Flags. (V1 Bravo)
FUNCTION
          Signaling flags. These flags are AND'ed with 'other'
          signaling flags, this is up to the classes implementation.
EXAMPLE
          BST_ApplicationClass, mth_SetAttr_Application

BTA_SYSTEM/BTA_Signals_OR

NAME
          BTA_Signals_OR -- BTA_type_Flags. (V1 Bravo)
FUNCTION
          Signaling flags. These flags are OR'ed with 'other'
          signaling flags, this is up to the classes implementation.
EXAMPLE
          BST_ApplicationClass, mth_SetAttr_Application

BTA_SYSTEM/BTA_Signals_XOR

NAME
          BTA_Signals_XOR -- BTA_type_Flags. (V1 Bravo)
FUNCTION
          Signaling flags. These flags are XOR'ed with 'other'
          signaling flags, this is up to the classes implementation.
EXAMPLE
          BST_ApplicationClass, mth_SetAttr_Application

BTA_TYPES/BTA_Flags

NAME
          BTA_Flags -- BTA_type_Flags (V1 Bravo)
FUNCTION
          Contains flags, no special definition of the flags.

BTA_TYPES/BTA_LongNumber

NAME
          BTA_LongNumber -- BTA_type_Plain (V1 Alpha)
FUNCTION
          Contains a long number, no special meaning.

TagLists/BST_bits_Family

NAME
          BST_bits_Family -- (V1 Bravo)
FUNCTION
          Defines the family to which the tag belongs.
          BTA_type_General = Tags defined by the BEAST general classes.
          BTA_type_B52     = Tags defined by B52/BEAST classes.
          BTA_type_BeaVis  = Tags defined by BeaVis.
          BTA_type_BFS     = Tags defined by BFS (Beast FileSystem) classes.
          BTA_type_BeaMM   = Tags defined by BeaMM (Beast MultiMedia) classes.
          BTA_type_BEASTAR = Tags defined by BEASTAR classes.
SEE ALSO
          OBM_bits_FAMILY

TagLists/BST_bits_System

NAME
          BST_bits_System -- (V1 Alpha)
FUNCTION
          These bits are reserved by Beast.
          They define a spacial behaviour of the tags.

TagLists/BST_bits_Types

NAME
          BST_bits_Types -- (V1 Bravo)
FUNCTION
          These tag numbers define the 'Type' of tag. Jeroen Vermeulen has done
          the early proposal to have such a type definition mask. Methods may
          set the type value as they like. However methods are not forced to
          check _different_ type values. The types _cannot_ be or'ed, they are
          standalone.

          BST_bits_Types = A 8-bits mask, to define the types field.

TagLists/TagLists

NAME
          Introduction -- Tags definitions. (V1 Bravo)

FUNCTION
          Data to and from methods is done with TagLists. The principle is the same
          as the standard Amiga TagLists. However Beast uses its own implementation,
          the TagLists are downwards compatible with the Amiga TagLists but add extra
          functionality.

          IMPORTANT: Please note that _very_ few tags are defined in this version.
          As soon as the Beast classes are starting to appear the number of Beast
          tags will raise quickly.

          A tag is defined by 32 bits, bit 31 is always set (TAG_USER). The tags
          are defined in the beast include file, BEAST:Include/Beast directory.

SEE ALSO
          Amiga Rom Kernel Manual about the basic definition of TagLists.

Tags/BFS_FILESYSTEM

NAME
          BFS_FILESYSTEM -- (V1 Bravo)
FUNCTION
          Tags used by BFS Beast FileSystem classes.
          All tags have the BTA_type_BFS flag set.

Tags/BTA_CONTROL

NAME
          BTA_CONTROL -- (V1 Alpha)
FUNCTION
          Beast control tags, these tags control in some way the behaviour of
          the TagList.

Tags/BTA_IDENTIFIER

NAME
          BTA_IDENTIFIER -- (V1 Bravo)
FUNCTION
          Beast identifier tags, used as key for objects/data
          structures..etc..

Tags/BTA_POSITION

NAME
          BTA_POSITION -- (V1 Alpha)
FUNCTION
          Beast position tags, the tags define all sorts of position
          related items.

Tags/BTA_SYSTEM

NAME
          BTA_SYSTEM -- (V1 Bravo)
FUNCTION
          Tags used by beast system classes.

Tags/BTA_TYPES

NAME
          BTA_TYPES -- (V1 Bravo)
FUNCTION
          Beast types tags (BTA_TYPES) have a direct meaning. Their tag value may
          _not_ being altered into another type.