@ GNU AS assembler header file for OSFile
@ Written by DefMod (Dec  9 2012) on Sun Dec  9 15:44:51 2012
@ Jonathan Coxhead, jonathan@doves.demon.co.uk, 21 Aug 1995

@ OSLib---efficient, type-safe, transparent, extensible,
@ register-safe API coverage of RISC OS
@ 
@ Copyright (c) 1994-2012 Jonathan Coxhead and OSLib maintainers
@ 
@ Licence:
@ 
@    OSLib is free software; you can redistribute it and/or modify
@ it under the terms of the GNU General Public License as published by
@ the Free Software Foundation; either version 1, or (at your option)
@ any later version - and this with the following clarification and
@ special exception:
@ 
@    Linking this library statically or dynamically with other modules
@ is making a combined work based on this library. Thus, the terms
@ and conditions of the GNU General Public License cover the whole
@ combination.
@ 
@    As a special exception, the copyright holders of this library
@ give you permission to link this library with independent modules
@ to produce an executable, regardless of the license terms of these
@ independent modules, and to copy and distribute the resulting
@ executable under terms of your choice, provided that you also meet,
@ for each linked independent module, the terms and conditions of the
@ license of that module. An independent module is a module which is
@ not derived from or based on this library. If you modify this
@ library, you may extend this exception to your version of the library,
@ but you are not obliged to do so. If you do not wish to do so, delete
@ this exception statement from your version.
@ 
@    OSLib is distributed in the hope that it will be useful,
@ but WITHOUT ANY WARRANTY; without even the implied warranty of
@ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
@ GNU General Public License for more details.
@ 
@    You should have received a copy of the GNU General Public License
@ along with this programme; if not, write to the Free Software
@ Foundation, Inc, 675 Mass Ave, Cambridge, MA 02139, USA.

#ifndef OSFile_Hdr
#  define OSFile_Hdr

#  ifndef Get_Types
#    define Get_Types
#    include "oslib/Types.Hdr"
#  endif

#  ifndef Get_OS
#    define Get_OS
#    include "oslib/OS.Hdr"
#  endif

#  ifndef Get_FileSwitch
#    define Get_FileSwitch
#    include "oslib/FileSwitch.Hdr"
#  endif

@Symbols for constants
#  define OSFile_NotFound 0x0
#  define OSFile_IsFile 0x1
#  define OSFile_IsDir 0x2
#  define OSFile_IsImage 0x3
#  define OSFile_FileType 0xfff00
#  define OSFile_FileTypeShift 0x8
#  define OSFile_TypeDraw 0xaff
#  define OSFile_TypeBBCROM 0xbbc
#  define OSFile_TypeCode 0xf95
#  define OSFile_TypeResource 0xfae
#  define OSFile_TypeDOSDisc 0xfc8
#  define OSFile_TypeDevice 0xfcc
#  define OSFile_TypeCache 0xfcf
#  define OSFile_TypeTaskExec 0xfd6
#  define OSFile_TypeTaskObey 0xfd7
#  define OSFile_TypeDOS 0xfe4
#  define OSFile_TypeDesktop 0xfea
#  define OSFile_TypeObey 0xfeb
#  define OSFile_TypeTemplate 0xfec
#  define OSFile_TypePalette 0xfed
#  define OSFile_TypeConfig 0xff2
#  define OSFile_TypePrintout 0xff4
#  define OSFile_TypePostscript 0xff5
#  define OSFile_TypeFont 0xff6
#  define OSFile_TypeBBCFont 0xff7
#  define OSFile_TypeAbsolute 0xff8
#  define OSFile_TypeSprite 0xff9
#  define OSFile_TypeModule 0xffa
#  define OSFile_TypeBASIC 0xffb
#  define OSFile_TypeUtility 0xffc
#  define OSFile_TypeData 0xffd
#  define OSFile_TypeCommand 0xffe
#  define OSFile_TypeText 0xfff
#  define OSFile_TypeDir 0x1000
#  define OSFile_TypeApplication 0x2000
#  define OSFile_TypeUntyped 0xffffffff
#  define OSFile_LoadFlagsIsCode 0x80000000

@Symbols for structure offsets and sizes
        .struct 0
        .skip   Bits
OSFile_LoadFlags               : 


@Symbols for SWI's and SWI reason codes
.set XOS_File,0x20008
.set OS_File,0x8

#  define OSFile_SaveStamped 0xa
   @Entry
   @  R0 = &A
   @  R1 -> file_name (String)
   @  R2 = file_type (Bits)
   @  R4 -> data (data)
   @  R5 -> end (data)

#  define OSFile_Write 0x1
   @Entry
   @  R0 = &1
   @  R1 -> file_name (String)
   @  R2 = load_addr (Bits)
   @  R3 = exec_addr (Bits)
   @  R5 = attr (FileSwitch_Attr)

#  define OSFile_WriteLoad 0x2
   @Entry
   @  R0 = &2
   @  R1 -> file_name (String)
   @  R2 = load_addr (Bits)

#  define OSFile_WriteExec 0x3
   @Entry
   @  R0 = &3
   @  R1 -> file_name (String)
   @  R3 = exec_addr (Bits)

#  define OSFile_WriteAttr 0x4
   @Entry
   @  R0 = &4
   @  R1 -> file_name (String)
   @  R5 = attr (FileSwitch_Attr)

#  define OSFile_Stamp 0x9
   @Entry
   @  R0 = &9
   @  R1 -> file_name (String)

#  define OSFile_SetType 0x12
   @Entry
   @  R0 = &12
   @  R1 -> file_name (String)
   @  R2 = file_type (Bits)

#  define OSFile_Delete 0x6
   @Entry
   @  R0 = &6
   @  R1 -> file_name (String)
   @Exit
   @  R0 = obj_type (FileSwitch_ObjectType)
   @  R2 = load_addr (Bits)
   @  R3 = exec_addr (Bits)
   @  R4 = size (Int)
   @  R5 = attr (FileSwitch_Attr)

#  define OSFile_CreateStamped 0xb
   @Entry
   @  R0 = &B
   @  R1 -> file_name (String)
   @  R2 = file_type (Bits)
   @  R4 = &0
   @  R5 = size (Int)

#  define OSFile_CreateDir 0x8
   @Entry
   @  R0 = &8
   @  R1 -> dir_name (String)
   @  R4 = entry_count (Int)

#  define OSFile_LoadStampedPath 0xc
   @Entry
   @  R0 = &C
   @  R1 -> file_name (String)
   @  R2 = addr (pointer to data)
   @  R3 = &0
   @  R4 -> path (String)
   @Exit
   @  R0 = obj_type (FileSwitch_ObjectType)
   @  R2 = load_addr (Bits)
   @  R3 = exec_addr (Bits)
   @  R4 = size (Int)
   @  R5 = attr (FileSwitch_Attr)

#  define OSFile_LoadStampedPathWithFlags 0xc
   @Entry
   @  R0 = &C
   @  R1 -> file_name (String)
   @  R2 = addr (pointer to data)
   @  R3 = flags (OSFile_LoadFlags)
   @  R4 -> path (String)
   @Exit
   @  R0 = obj_type (FileSwitch_ObjectType)
   @  R2 = load_addr (Bits)
   @  R3 = exec_addr (Bits)
   @  R4 = size (Int)
   @  R5 = attr (FileSwitch_Attr)

#  define OSFile_LoadStampedPathVar 0xe
   @Entry
   @  R0 = &E
   @  R1 -> file_name (String)
   @  R2 = addr (pointer to data)
   @  R3 = &0
   @  R4 -> var (String)
   @Exit
   @  R0 = obj_type (FileSwitch_ObjectType)
   @  R2 = load_addr (Bits)
   @  R3 = exec_addr (Bits)
   @  R4 = size (Int)
   @  R5 = attr (FileSwitch_Attr)

#  define OSFile_LoadStampedPathVarWithFlags 0xe
   @Entry
   @  R0 = &E
   @  R1 -> file_name (String)
   @  R2 = addr (pointer to data)
   @  R3 = flags (OSFile_LoadFlags)
   @  R4 -> var (String)
   @Exit
   @  R0 = obj_type (FileSwitch_ObjectType)
   @  R2 = load_addr (Bits)
   @  R3 = exec_addr (Bits)
   @  R4 = size (Int)
   @  R5 = attr (FileSwitch_Attr)

#  define OSFile_LoadStampedNoPath 0x10
   @Entry
   @  R0 = &10
   @  R1 -> file_name (String)
   @  R2 = addr (pointer to data)
   @  R3 = &0
   @Exit
   @  R0 = obj_type (FileSwitch_ObjectType)
   @  R2 = load_addr (Bits)
   @  R3 = exec_addr (Bits)
   @  R4 = size (Int)
   @  R5 = attr (FileSwitch_Attr)

#  define OSFile_LoadStampedNoPathWithFlags 0x10
   @Entry
   @  R0 = &10
   @  R1 -> file_name (String)
   @  R2 = addr (pointer to data)
   @  R3 = flags (OSFile_LoadFlags)
   @Exit
   @  R0 = obj_type (FileSwitch_ObjectType)
   @  R2 = load_addr (Bits)
   @  R3 = exec_addr (Bits)
   @  R4 = size (Int)
   @  R5 = attr (FileSwitch_Attr)

#  define OSFile_LoadStamped 0xff
   @Entry
   @  R0 = &FF
   @  R1 -> file_name (String)
   @  R2 = addr (pointer to data)
   @  R3 = &0
   @Exit
   @  R0 = obj_type (FileSwitch_ObjectType)
   @  R2 = load_addr (Bits)
   @  R3 = exec_addr (Bits)
   @  R4 = size (Int)
   @  R5 = attr (FileSwitch_Attr)

#  define OSFile_LoadStampedWithFlags 0xff
   @Entry
   @  R0 = &FF
   @  R1 -> file_name (String)
   @  R2 = addr (pointer to data)
   @  R3 = flags (OSFile_LoadFlags)
   @Exit
   @  R0 = obj_type (FileSwitch_ObjectType)
   @  R2 = load_addr (Bits)
   @  R3 = exec_addr (Bits)
   @  R4 = size (Int)
   @  R5 = attr (FileSwitch_Attr)

#  define OSFile_MakeError 0x13
   @Entry
   @  R0 = &13
   @  R1 -> file_name (String)
   @  R2 = obj_type (FileSwitch_ObjectType)

#  define OSFile_ReadStamped 0x14
   @Entry
   @  R0 = &14
   @  R1 -> file_name (String)
   @Exit
   @  R0 = obj_type (FileSwitch_ObjectType)
   @  R2 = load_addr (Bits)
   @  R3 = exec_addr (Bits)
   @  R4 = size (Int)
   @  R5 = attr (FileSwitch_Attr)
   @  R6 = file_type (Bits)

#  define OSFile_ReadStampedPath 0x15
   @Entry
   @  R0 = &15
   @  R1 -> file_name (String)
   @  R4 -> path (String)
   @Exit
   @  R0 = obj_type (FileSwitch_ObjectType)
   @  R2 = load_addr (Bits)
   @  R3 = exec_addr (Bits)
   @  R4 = size (Int)
   @  R5 = attr (FileSwitch_Attr)
   @  R6 = file_type (Bits)

#  define OSFile_ReadStampedPathVar 0x16
   @Entry
   @  R0 = &16
   @  R1 -> file_name (String)
   @  R4 -> var (String)
   @Exit
   @  R0 = obj_type (FileSwitch_ObjectType)
   @  R2 = load_addr (Bits)
   @  R3 = exec_addr (Bits)
   @  R4 = size (Int)
   @  R5 = attr (FileSwitch_Attr)
   @  R6 = file_type (Bits)

#  define OSFile_ReadStampedNoPath 0x17
   @Entry
   @  R0 = &17
   @  R1 -> file_name (String)
   @Exit
   @  R0 = obj_type (FileSwitch_ObjectType)
   @  R2 = load_addr (Bits)
   @  R3 = exec_addr (Bits)
   @  R4 = size (Int)
   @  R5 = attr (FileSwitch_Attr)
   @  R6 = file_type (Bits)

#  define OSFile_ReadBlockSize 0x18
   @Entry
   @  R0 = &18
   @  R1 -> file_name (String)
   @Exit
   @  R2 = block_size (Int)

#  define OSFile_Save 0x0
   @Entry
   @  R0 = &0
   @  R1 -> file_name (String)
   @  R2 = load_addr (Bits)
   @  R3 = exec_addr (Bits)
   @  R4 -> data (data)
   @  R5 -> end (data)

#  define OSFile_Read 0x5
   @Entry
   @  R0 = &5
   @  R1 -> file_name (String)
   @Exit
   @  R0 = obj_type (FileSwitch_ObjectType)
   @  R2 = load_addr (Bits)
   @  R3 = exec_addr (Bits)
   @  R4 = size (Int)
   @  R5 = attr (FileSwitch_Attr)

#  define OSFile_ReadPath 0xd
   @Entry
   @  R0 = &D
   @  R1 -> file_name (String)
   @  R4 -> path (String)
   @Exit
   @  R0 = obj_type (FileSwitch_ObjectType)
   @  R2 = load_addr (Bits)
   @  R3 = exec_addr (Bits)
   @  R4 = size (Int)
   @  R5 = attr (FileSwitch_Attr)

#  define OSFile_ReadPathVar 0xf
   @Entry
   @  R0 = &F
   @  R1 -> file_name (String)
   @  R4 -> var (String)
   @Exit
   @  R0 = obj_type (FileSwitch_ObjectType)
   @  R2 = load_addr (Bits)
   @  R3 = exec_addr (Bits)
   @  R4 = size (Int)
   @  R5 = attr (FileSwitch_Attr)

#  define OSFile_ReadNoPath 0x11
   @Entry
   @  R0 = &11
   @  R1 -> file_name (String)
   @Exit
   @  R0 = obj_type (FileSwitch_ObjectType)
   @  R2 = load_addr (Bits)
   @  R3 = exec_addr (Bits)
   @  R4 = size (Int)
   @  R5 = attr (FileSwitch_Attr)

#  define OSFile_Create 0x7
   @Entry
   @  R0 = &7
   @  R1 -> file_name (String)
   @  R2 = load_addr (Bits)
   @  R3 = exec_addr (Bits)
   @  R4 = &0
   @  R5 = size (Int)

#  define OSFile_LoadPath 0xc
   @Entry
   @  R0 = &C
   @  R1 -> file_name (String)
   @  R3 = &1
   @  R4 -> path (String)
   @Exit
   @  R0 = obj_type (FileSwitch_ObjectType)
   @  R2 = load_addr (Bits)
   @  R3 = exec_addr (Bits)
   @  R4 = size (Int)
   @  R5 = attr (FileSwitch_Attr)

#  define OSFile_LoadPathVar 0xe
   @Entry
   @  R0 = &E
   @  R1 -> file_name (String)
   @  R3 = &1
   @  R4 -> var (String)
   @Exit
   @  R0 = obj_type (FileSwitch_ObjectType)
   @  R2 = load_addr (Bits)
   @  R3 = exec_addr (Bits)
   @  R4 = size (Int)
   @  R5 = attr (FileSwitch_Attr)

#  define OSFile_LoadNoPath 0x10
   @Entry
   @  R0 = &10
   @  R1 -> file_name (String)
   @  R3 = &1
   @Exit
   @  R0 = obj_type (FileSwitch_ObjectType)
   @  R2 = load_addr (Bits)
   @  R3 = exec_addr (Bits)
   @  R4 = size (Int)
   @  R5 = attr (FileSwitch_Attr)

#  define OSFile_Load 0xff
   @Entry
   @  R0 = &FF
   @  R1 -> file_name (String)
   @  R3 = &1
   @Exit
   @  R0 = obj_type (FileSwitch_ObjectType)
   @  R2 = load_addr (Bits)
   @  R3 = exec_addr (Bits)
   @  R4 = size (Int)
   @  R5 = attr (FileSwitch_Attr)

#  define FileV 0x8

#  define UpCallFile_Save 0x0
   @Entry
   @  R0 = &3
   @  R1 -> file_name (String)
   @  R2 = load_addr (Bits)
   @  R3 = exec_addr (Bits)
   @  R4 -> data (data)
   @  R5 -> end (data)
   @  R6 -> special (String)
   @  R8 = fs_info (FileSwitch_FSInfo)
   @  R9 = &0

#  define UpCallFile_SetArgs 0x1
   @Entry
   @  R0 = &3
   @  R1 -> file_name (String)
   @  R2 = load_addr (Bits)
   @  R3 = exec_addr (Bits)
   @  R5 = attr (FileSwitch_Attr)
   @  R6 -> special (String)
   @  R8 = fs_info (FileSwitch_FSInfo)
   @  R9 = &1

#  define UpCallFile_SetLoadAddr 0x2
   @Entry
   @  R0 = &3
   @  R1 -> file_name (String)
   @  R2 = load_addr (Bits)
   @  R6 -> special (String)
   @  R8 = fs_info (FileSwitch_FSInfo)
   @  R9 = &2

#  define UpCallFile_SetExecAddr 0x3
   @Entry
   @  R0 = &3
   @  R1 -> file_name (String)
   @  R3 = exec_addr (Bits)
   @  R6 -> special (String)
   @  R8 = fs_info (FileSwitch_FSInfo)
   @  R9 = &3

#  define UpCallFile_SetAttr 0x4
   @Entry
   @  R0 = &3
   @  R1 -> file_name (String)
   @  R5 = attr (FileSwitch_Attr)
   @  R6 -> special (String)
   @  R8 = fs_info (FileSwitch_FSInfo)
   @  R9 = &4

#  define UpCallFile_Delete 0x6
   @Entry
   @  R0 = &3
   @  R1 -> file_name (String)
   @  R6 -> special (String)
   @  R8 = fs_info (FileSwitch_FSInfo)
   @  R9 = &6

#  define UpCallFile_Create 0x7
   @Entry
   @  R0 = &3
   @  R1 -> file_name (String)
   @  R2 = load_addr (Bits)
   @  R3 = exec_addr (Bits)
   @  R4 -> data (data)
   @  R5 -> end (data)
   @  R6 -> special (String)
   @  R8 = fs_info (FileSwitch_FSInfo)
   @  R9 = &7

#  define UpCallFile_CreateDir 0x8
   @Entry
   @  R0 = &3
   @  R1 -> file_name (String)
   @  R2 = load_addr (Bits)
   @  R3 = exec_addr (Bits)
   @  R4 = entry_count (Int)
   @  R6 -> special (String)
   @  R8 = fs_info (FileSwitch_FSInfo)
   @  R9 = &8

#endif
