dos.h

Go to the documentation of this file.

/*  WFIO - the Wheefun IO Library
    Copyright (C) 2018  Phillip Kilgore

    This program 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 3 of the License, or
    (at your option) any later version.

    This program 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 program.  If not, see <https://www.gnu.org/licenses/>.
    
    Additionally, you should have recieved a copy of the GNU Classpath 
    exception, which amends the license to generally permit linking against
    the software provided herein.
*/

#ifndef WFIO_OS_DOS_H
#define WFIO_OS_DOS_H

#include <wfio/type.h>

WFIO_C_BEGIN

typedef wfio_sint16_t wfio_dos_sword_t;
typedef wfio_uint16_t wfio_dos_uword_t;
typedef wfio_sint32_t wfio_dos_sdword_t;
typedef wfio_uint32_t wfio_dos_udword_t;

typedef enum wfio_dos_opendir_t {
    WFIO_DOS_OMODE_RD,
    WFIO_DOS_OMODE_WR,
    WFIO_DOS_OMODE_RW,
    WFIO_DOS_OMODE_BAD
} wfio_dos_opendir_t;

typedef enum wfio_dos_share_t {
    WFIO_DOS_SMODE_COMPAT,
    WFIO_DOS_SMODE_RW,
    WFIO_DOS_SMODE_RDONLY,
    WFIO_DOS_SMODE_WRONLY,
    WFIO_DOS_SMODE_FULL
} wfio_dos_share_t;

typedef enum wfio_dos_fexist_t {
    WFIO_DOS_FEXIST_ERR,
    WFIO_DOS_FEXIST_OPEN,
    WFIO_DOS_FEXIST_TRUNC
} wfio_dos_fexist_t;

enum { 
    WFIO_DOS_NEXIST_CREAT = 0x10,
    
    /* Version Constants */
    
    WFIO_DOS_VERSION_UNKNOWN = 0,
    
    WFIO_DOS_VERSION_HOST = 0,
    
    WFIO_DOS_VERSION_1 = 0x100,
    
    WFIO_DOS_VERSION_1_25 = 0x119,
    
    WFIO_DOS_VERSION_2 = 0x200,
    
    WFIO_DOS_VERSION_3 = 0x300,
    
    WFIO_DOS_VERSION_4 = 0x400,
    
    WFIO_DOS_VERSION_5 = 0x500,
    
    WFIO_DOS_VERSION_6 = 0x600
};

typedef union wfio_dos_sversion_t {
    
    struct {
        #ifdef WFIO_ENDIAN_HOST_IS_LIL
        wfio_uint8_t min;
        wfio_uint8_t maj;
        #else
        wfio_uint8_t maj;
        wfio_uint8_t min;
        #endif
        
    } u8;
    
    wfio_dos_uword_t u16;
} wfio_dos_sversion_t;

typedef wfio_dos_uword_t wfio_dos_version_t;

typedef union wfio_dos_openflags_t {
    struct {
        wfio_dos_uword_t mode:3;
        wfio_dos_uword_t resv0_:1;
        wfio_dos_uword_t share:3;
        wfio_dos_uword_t priv:1;
        wfio_dos_uword_t resv1_:5;
        wfio_dos_uword_t eret:1;
        wfio_dos_uword_t acommit:1;
        wfio_dos_uword_t resv2_:1;
    } bits;
    wfio_dos_uword_t raw;
} wfio_dos_openflags_t;

typedef union wfio_dos_fileattr_t {
    struct {
        wfio_uint8_t rdonly:1;
        wfio_uint8_t hidden:1;
        wfio_uint8_t system:1;
        wfio_uint8_t vlabel:1;
        wfio_uint8_t subdir:1;
        wfio_uint8_t archive:1;
        wfio_uint8_t resv0_:1;
    } bits;
    wfio_uint8_t raw;
} wfio_dos_fileattr_t;

typedef union wfio_dos_creat_t {
    struct {
        wfio_dos_uword_t exist:4;
        wfio_dos_uword_t create:4;
    } bits;
    wfio_uint8_t raw;
} wfio_dos_creat_t;

typedef struct wfio_dos_open_t {
    wfio_dos_openflags_t omode;
    wfio_dos_fileattr_t fmode;
    wfio_dos_creat_t cmode;
} wfio_dos_open_t;


/* DPMI */

typedef struct wfio_dos_dpmi_regsd_t {
    /* Indexing Registers */
    
    wfio_dos_udword_t edi;
    
    wfio_dos_udword_t esi;
    
    wfio_dos_udword_t ebp;
    
    wfio_dos_udword_t res;
    
    /* General-purpose registers */
    
    wfio_dos_udword_t ebx;
    
    wfio_dos_uword_t edx;
    
    wfio_dos_udword_t ecx;
    
    wfio_dos_udword_t eax;
    
    
    /* Flags */
    
    wfio_dos_uword_t flags;
    
    wfio_dos_uword_t es;
    
    wfio_dos_uword_t ds;
    
    wfio_dos_uword_t fs;
    
    wfio_dos_uword_t gs;
    
    /* Other registers */
    
    wfio_dos_uword_t ip;
    
    wfio_dos_uword_t cs;
    
    wfio_dos_uword_t sp;
    
    wfio_dos_uword_t ss;
} wfio_dos_dpmi_regsd_t;

typedef struct wfio_dos_dpmi_regsw_t {
    /* Indexing Registers */
    
    wfio_dos_uword_t di;
    
    wfio_dos_uword_t diHi;
    
    wfio_dos_uword_t si;
    
    wfio_dos_uword_t siHi;
    
    wfio_dos_uword_t bp;
    
    wfio_dos_uword_t bpHi;
    
    wfio_dos_udword_t res;
    
    /* General-purpose registers */
    
    wfio_dos_uword_t bx;
    
    wfio_dos_uword_t bxHi;
    
    wfio_dos_uword_t dx;
    
    wfio_dos_uword_t dxHi;
    
    wfio_dos_uword_t cx;
    
    wfio_dos_uword_t cxHi;
    
    wfio_dos_uword_t ax;
    
    wfio_dos_uword_t axHi;
    
    /* Flags */
    
    wfio_dos_uword_t flags;
    
    /* Spare Segment Registers */
    wfio_dos_uword_t es;
    wfio_dos_uword_t ds;
    wfio_dos_uword_t fs;
    wfio_dos_uword_t gs;
    
    /* Other registers */
    wfio_dos_uword_t ip;
    wfio_dos_uword_t cs;
    wfio_dos_uword_t sp;
    wfio_dos_uword_t ss;
} wfio_dos_dpmi_regsw_t;

typedef struct wfio_dos_dpmi_regsb_t {
    /* Indexing Registers */
    
    wfio_dos_uword_t di;
    
    wfio_dos_uword_t diHi;
    
    wfio_dos_uword_t si;
    
    wfio_dos_uword_t siHi;
    
    wfio_dos_uword_t bp;
    
    wfio_dos_uword_t bpHi;
    
    wfio_dos_udword_t res;
    
    /* General-purpose registers */
    
    wfio_uint8_t bl;
    
    wfio_uint8_t bh;
    
    wfio_uint8_t blHi;
    
    wfio_uint8_t bhHi;
    
    wfio_uint8_t dl;
    
    wfio_uint8_t dh;
    
    wfio_uint8_t dlHi;
    
    wfio_uint8_t dhHi;
    
    wfio_uint8_t cl;
    
    wfio_uint8_t ch;
    
    wfio_uint8_t clHi;
    
    wfio_uint8_t chHi;
    
    wfio_uint8_t al;
    
    wfio_uint8_t ah;
    
    wfio_uint8_t alHi;
    
    wfio_uint8_t ahHi;
    
    /* Flags */
    
    wfio_dos_uword_t flags;
    
    /* Spare Segment Registers */
    
    wfio_dos_uword_t es;
    
    wfio_dos_uword_t ds;
    
    wfio_dos_uword_t fs;
    
    wfio_dos_uword_t gs;
    
    /* Other registers */
    
    wfio_dos_uword_t ip;
    
    wfio_dos_uword_t cs;
    
    wfio_dos_uword_t sp;
    
    wfio_dos_uword_t ss;
} wfio_dos_dpmi_regsb_t;

typedef union wfio_dos_dpmi_regs_t {
    wfio_dos_dpmi_regsd_t d;
    wfio_dos_dpmi_regsw_t w;
    wfio_dos_dpmi_regsb_t b;
} wfio_dos_dpmi_regs_t;

typedef struct wfio_dos_farptr_t {
    wfio_dos_uword_t segment;
    wfio_dos_uword_t offset;
} wfio_dos_farptr_t;

WFIO_ALWAYS_INLINE wfio_dos_farptr_t wfio_dos_farptr(
    wfio_dos_uword_t segment, wfio_dos_uword_t offset) {
    register wfio_dos_farptr_t ret = { .segment = segment, .offset=offset };
    return ret;
}

#ifdef WFIO_COMPILER_DJGPP
#include <dpmi.h>
typedef union wfio_dos_dpmi_regs_t  wfio_dos_regs_t;

/* Call __dpmi_regs directly. */
WFIO_ALWAYS_INLINE int wfio_dos_dpmi_int(int vector, 
    wfio_dos_dpmi_regs_t* regs) {
    return __dpmi_int(vector, (__dpmi_regs*) regs) != -1;
}

WFIO_ALWAYS_INLINE int wfio_dos_int(int vector, wfio_dos_regs_t* regs) {
    return __dpmi_int(vector, (__dpmi_regs*) regs) != -1;
}

#define WFIO_DOS_INT_INLINE_
#else

typedef union wfio_dos_dpmi_regs_t  wfio_dos_regs_t;

WFIO_DLL_FASTCALL int wfio_dos_dpmi_int(int vector, 
    wfio_dos_dpmi_regs_t* regs);
    
WFIO_DLL_FASTCALL int wfio_dos_int(int vector, wfio_dos_regs_t* regs);
#endif

WFIO_ALWAYS_INLINE int wfio_dos_syscall(wfio_dos_regs_t* regs) {
    return wfio_dos_int(0x21, regs);
}
 
WFIO_DLL_FASTCALL wfio_dos_version_t wfio_dos_version();

WFIO_DLL_FASTCALL int wfio_dos_open3C(const char* path, 
    wfio_dos_fileattr_t attrs, int* error);

WFIO_DLL_FASTCALL int wfio_dos_open3D(const char* path, 
    wfio_dos_openflags_t flags, int* error);

WFIO_DLL_FASTCALL int wfio_dos_open6C(const char* path, 
    wfio_dos_open_t flags, int* error);

WFIO_DLL_FASTCALL int wfio_dos_openEx(const char* path, wfio_dos_open_t flags, 
    wfio_dos_version_t ver, int* error);  

WFIO_ALWAYS_INLINE int wfio_dos_open(const char* path, wfio_dos_open_t flags,
    int* error) {
    return wfio_dos_openEx(path, flags, 0x0, error);
}

/* Conversion */

WFIO_DLL_FASTCALL wfio_openmode_t wfio_dos_openToWFIO(
    wfio_dos_open_t flags);

WFIO_DLL_FASTCALL wfio_dos_open_t wfio_dos_wfioToOpen(
    wfio_openmode_t flags);

WFIO_C_END

#endif