home *** CD-ROM | disk | FTP | other *** search
/ Club Amiga de Montreal - CAM / CAM_CD_1.iso / files / 302.lha / ILBMLib / FileIO.h < prev    next >
Encoding:
C/C++ Source or Header  |  1980-12-03  |  7.1 KB  |  191 lines
  1.  
  2. #ifndef FILEIO_H
  3. #define FILEIO_H
  4.  
  5. /* *** fileio.h *************************************************************
  6.  *
  7.  * Amiga Programmers' Suite  --  File IO Include File
  8.  *     from Book 1 of the Amiga Programmers' Suite by RJ Mical
  9.  *
  10.  * Copyright (C) 1986, =Robert J. Mical=
  11.  * All Rights Reserved.
  12.  *
  13.  * Created for Amiga developers.
  14.  * Any or all of this code can be used in any program as long as this
  15.  * entire notice is retained, ok?  Thanks.
  16.  *
  17.  * The Amiga Programmer's Suite Book 1 is copyrighted but freely distributable.
  18.  * All copyright notices and all file headers must be retained intact.
  19.  * The Amiga Programmer's Suite Book 1 may be compiled and assembled, and the 
  20.  * resultant object code may be included in any software product.  However, no 
  21.  * portion of the source listings or documentation of the Amiga Programmer's 
  22.  * Suite Book 1 may be distributed or sold for profit or in a for-profit 
  23.  * product without the written authorization of the author, RJ Mical.
  24.  * 
  25.  * HISTORY      NAME            DESCRIPTION
  26.  * -----------  --------------  --------------------------------------------
  27.  * 20 Oct 87    - RJ            Added RENAME_RAMDISK to fix what seems to 
  28.  *                              be a bug in AmigaDOS.
  29.  * 27 Sep 87    RJ              Removed reference to alerts.h, brought 
  30.  *                              declarations into this file
  31.  * 12 Aug 86    RJ              Prepare (clean house) for release
  32.  * 14 Feb 86    =RJ Mical=      Created this file.
  33.  * 26 Sept 87   Jeff Glatt      Converted C code to optimized assembly and
  34.  *                              created a library.
  35.  * *********************************************************************** */
  36.  
  37.  
  38. #define MAX_NAME_LENGTH 30
  39. #define MAX_DRAWER_LENGTH 132
  40. #define SetFlag(v,f)      ((v)|=(f))
  41. #define ClearFlag(v,f)    ((v)&=~(f))
  42. #define ToggleFlag(v,f)   ((v)^=(f))
  43. #define FlagIsSet(v,f)    ((BOOL)(((v)&(f))!=0))
  44.  
  45. struct HandlerBlock {
  46.    APTR  StartUpCode;
  47.    APTR  DiskInsertedCode;
  48.    APTR  GadgetCode;
  49.    APTR  KeyCode;
  50.    APTR  MouseMoveCode;
  51.    };
  52.  
  53. /* === FileIO Structure ========================================== */
  54.  
  55. struct FileIO {
  56.    USHORT Flags;
  57.    /* After a successful call to DoFileIO(), these fields will have
  58.     * the names selected by the user.  You should never have to initialize
  59.     * these fields, only read from them, though initializing them won't hurt.
  60.     */
  61.    UBYTE FileName[MAX_NAME_LENGTH];
  62.    UBYTE Drawer[MAX_DRAWER_LENGTH];
  63.    UBYTE Disk[MAX_NAME_LENGTH];
  64.  
  65.    /* If a Lock on a disk/dir was obtained, it can be found here. */
  66.    struct DOSLock *Lock;
  67.  
  68.    USHORT NameCount;
  69.    USHORT NameStart;
  70.    SHORT  CurrPick;
  71.    struct Remember *FileList;
  72.  
  73.    USHORT VolIndex;
  74.    USHORT VolCount;
  75.    struct Remember *VolList;
  76.  
  77.    SHORT MatchType;  /* DiskObject Type */
  78.    UBYTE *ToolTypes;
  79.  
  80.    UBYTE *Extension;
  81.    USHORT ExtSize; /* Don't count the terminating NULL */
  82.  
  83.    struct HandlerBlock *Custom;
  84.  
  85.    USHORT X;
  86.    USHORT Y;
  87.  
  88.    ULONG  FreeBytes;
  89.    ULONG  FileSize;
  90.  
  91.    UBYTE  *Title;
  92.    UBYTE  *Buffer;
  93.  
  94.    APTR   RawCode;
  95.    struct DOSLock  *OriginalLock;
  96.    BYTE   Errno;
  97.    UBYTE  DrawMode;
  98.    UBYTE  PenA;
  99.    UBYTE  PenB;
  100.    };
  101.  
  102. /* === User FileIO Flag Definitions === */
  103. #define NO_CARE_REDRAW     0x0001  /* Clear if reconstructing display */
  104. #define USE_DEVICE_NAMES   0x0002  /* Set for device instead of volume names */
  105. #define EXTENSION_MATCH    0x0004  /* Only display those that end with
  106.                                       a specified string */
  107. #define DOUBLECLICK_OFF    0x0008  /* Inhibit double-clicking if set */
  108. #define WBENCH_MATCH       0x0010  /* If set check .info files only */
  109. #define MATCH_OBJECTTYPE   0x0020  /* If set with .info also check ObjectType */
  110. #define MATCH_TOOLTYPE     0x0040  /* If set with .info also check ToolType */
  111. #define INFO_SUPPRESS      0x0080  /* No info files listed */
  112. #define CUSTOM_HANDLERS    0x0200  /* Implement custom handlers */
  113.  
  114. /* === System FileIO Flag Definitions === */
  115. #define ALLOCATED_FILEIO   0x0100  /* Not a pre-initialized FileIO struct */
  116. #define WINDOW_OPENED      0x0400  /* DoFileIOWindow() was called */
  117. #define TITLE_CHANGED      0x0800  /* SetTitle() called without ResetTitle()
  118.                                    */
  119. #define DISK_HAS_CHANGED   0x2000  /* Disk changed during DoFileIO() */
  120.  
  121. /*  FileRequester GadgetIDs - Do not use these IDs for your own gadgets */
  122. #define FILEIO_CANCEL      0x7FA0
  123. #define FILEIO_OK          0x7FA1
  124. #define FILEIO_NAMETEXT    0x7FA2
  125. #define FILEIO_DRAWERTEXT  0x7FA3
  126. #define FILEIO_DISKTEXT    0x7FA4
  127. #define FILEIO_SELECTNAME  0x7FA5
  128. #define FILEIO_UPGADGET    0x7FA6
  129. #define FILEIO_DOWNGADGET  0x7FA7
  130. #define FILEIO_PROPGADGET  0x7FA8
  131. #define FILEIO_NEXTDISK    0x7FA9
  132. #define FILEIO_BACKDROP    0x7FAA
  133.  
  134. #define NAME_ENTRY_COUNT   7   /* These many names in the SelectName box */
  135.  
  136. #define REQTITLE_HEIGHT    8
  137.  
  138. #define REQ_LEFT          8
  139. #define REQ_TOP           15
  140. #define REQ_WIDTH         286
  141. #define REQ_HEIGHT        (110 + REQTITLE_HEIGHT)
  142. #define REQ_LINEHEIGHT    8
  143.  
  144. #define SELECTNAMES_LEFT    8
  145. #define SELECTNAMES_TOP     (15 + REQTITLE_HEIGHT)
  146. #define SELECTNAMES_WIDTH   122
  147. #define SELECTNAMES_HEIGHT  60
  148.  
  149.  
  150.  /* ======= ERRNO numbers returned in FileIO error field ========= */
  151.  
  152. #define ERR_MANUAL  1   /* the path was entered manually via the title bar
  153.                            with no errors or cancellation. */
  154. #define ERR_SUCCESS 0   /* everything went OK */
  155. #define ERR_CANCEL  -1  /* the filename procedure was CANCELED by the user */
  156. #define ERR_WINDOW  -2  /* the window couldn't open (in DoFileIOWindow()) */
  157. #define ERR_APPGADG -3  /* the requester was CANCELED by an application gadget
  158.                            (via an installed CUSTOM gadget handler returning TRUE) */
  159.  
  160. /* === AutoFileMessage() Numbers ================================= */
  161. #define ALERT_OUTOFMEM            0
  162. #define ALERT_BAD_DIRECTORY       1
  163. #define READ_WRITE_ERROR          2 /* Error in reading or writing file */
  164.  /* The next 3 display "YES" and "NO" prompts,
  165.     returning d0=1 for yes, 0 for no */
  166. #define FILE_EXISTS               3 /* File already exists. Overwrite? */
  167. #define SAVE_CHANGES              4 /* Changes have been made. Save them? */
  168. #define REALLY_QUIT               5 /* Do you really want to quit? */
  169.  
  170. /* === Requester Library Function Declarations ===================== */
  171.  
  172. extern struct FileIO *GetFileIO();
  173. extern UBYTE  *DoFileIO();
  174. extern UBYTE  *DoFileIOWindow();  /* address = DoFileIOWindow(myFileIO, myScreen);
  175.                                   If myScreen is NULL, then use WB screen */
  176. extern BOOL   AutoFileMessage(); /* result = AutoFileMessage(3L, myWindow); */
  177. extern BOOL   AutoMessage(), AutoMessageLen(), AutoPrompt3();
  178. extern void   ReleaseFileIO();
  179. extern void   SetWaitPointer();  /* SetWaitPointer( myWindow ); */
  180. extern void   ResetBuffer();     /* ResetBuffer( StringInfo, nullFlag ); resets the
  181.                              cursor back to the first char in the stringinfo's
  182.                              buffer. If nullFlag is TRUE, then NULLS the buffer
  183.                              as well. */
  184. extern UBYTE  *ParseString();
  185. extern UBYTE  *TypeFileName();
  186. extern UBYTE  *PromptUserEntry(), *UserEntry();
  187. extern void   SetTitle(), ResetTitle();
  188. extern UWORD  GetRawkey(), DecodeRawkey();
  189.  
  190. #endif /* of FILEIO_H */
  191.