claunia/libcdio-osx
Archived
1
0
Fork 0
Code Issues 2 Pull Requests Actions Packages Projects Releases Wiki Activity

update/add More doxygen tagging

Browse Source
This commit is contained in:
rocky
2003-11-05 12:40:34 +00:00
parent e98490dde5
commit 5b27971ac3
3 changed files with 294 additions and 152 deletions
Download Patch File Download Diff File Expand all files Collapse all files

162
include/cdio/iso9660.h
View File

@@ -1,5 +1,5 @@
/*
$Id: iso9660.h,v 1.27 2003/11/04 04:45:24 rocky Exp $
$Id: iso9660.h,v 1.28 2003/11/05 12:40:35 rocky Exp $
Copyright (C) 2000 Herbert Valerio Riedel <hvr@gnu.org>
Copyright (C) 2003 Rocky Bernstein <rocky@panix.com>
@@ -23,9 +23,9 @@
along with this program; if not, write to the Free Software
Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
*/
/*
* Header file iso9660.h - assorted structure definitions and typecasts.
specific to iso9660 filesystem.
/*!
* \file iso9660.h - Assorted structure definitions and typecasts.
* specific for the ISO 9660 filesystem.
*/
@@ -42,16 +42,19 @@
#define MIN_TRACK_SIZE 4*75
#define MIN_ISO_SIZE MIN_TRACK_SIZE
/*
A ISO filename is: "abcde.eee;1" -> <filename> '.' <ext> ';' <version #>
/*!
An ISO filename is: "abcde.eee;1" -> <filename> '.' <ext> ';' <version #>
The maximum needed string length is:
\verbatim
30 chars (filename + ext)
+ 2 chars ('.' + ';')
+ strlen("32767")
+ null byte
================================
= 38 chars
\endverbatim
*/
#define LEN_ISONAME 31
#define MAX_ISONAME 37
@@ -61,26 +64,28 @@
/*
* ISO 9660 directory flags.
*/
#define ISO_FILE 0 /* Not really a flag... */
#define ISO_EXISTENCE 1 /* Do not make existence known (hidden) */
#define ISO_DIRECTORY 2 /* This file is a directory */
#define ISO_ASSOCIATED 4 /* This file is an assiciated file */
#define ISO_RECORD 8 /* Record format in extended attr. != 0 */
#define ISO_PROTECTION 16 /* No read/execute perm. in ext. attr. */
#define ISO_DRESERVED1 32 /* Reserved bit 5 */
#define ISO_DRESERVED2 64 /* Reserved bit 6 */
#define ISO_MULTIEXTENT 128 /* Not final entry of a mult. ext. file */
#define ISO_FILE 0 /**< Not really a flag... */
#define ISO_EXISTENCE 1 /**< Do not make existence known (hidden) */
#define ISO_DIRECTORY 2 /**< This file is a directory */
#define ISO_ASSOCIATED 4 /**< This file is an associated file */
#define ISO_RECORD 8 /**< Record format in extended attr. != 0 */
#define ISO_PROTECTION 16 /**< No read/execute perm. in ext. attr. */
#define ISO_DRESERVED1 32 /**< Reserved bit 5 */
#define ISO_DRESERVED2 64 /**< Reserved bit 6 */
#define ISO_MULTIEXTENT 128 /**< Not final entry of a mult. ext. file */
/* Volume descriptor types */
#define ISO_VD_PRIMARY 1
#define ISO_VD_SUPPLEMENTARY 2 /* Used by Joliet */
#define ISO_VD_SUPPLEMENTARY 2 /**< Used by Joliet */
#define ISO_VD_END 255
#define ISO_PVD_SECTOR 16 /* Sector of Primary Volume Descriptor */
#define ISO_EVD_SECTOR 17 /* Sector of End Volume Descriptor */
#define ISO_PVD_SECTOR 16 /**< Sector of Primary Volume Descriptor */
#define ISO_EVD_SECTOR 17 /**< Sector of End Volume Descriptor */
#define ISO_STANDARD_ID "CD001"
#define ISO_BLOCKSIZE 2048
#define ISO_STANDARD_ID "CD001" /**< String inside track identifiying an
ISO 9660 filesystem. */
#define ISO_BLOCKSIZE 2048 /**< Number of bytes in an ISO
9660 block */
#ifdef __cplusplus
extern "C" {
@@ -97,12 +102,14 @@ PRAGMA_BEGIN_PACKED
struct iso9660_dtime {
uint8_t dt_year;
uint8_t dt_month; /* 1..12. Note 1 origin not 0, like a tm struct. */
uint8_t dt_month; /**< Has value in range 1..12. Note starts
at 1, not 0 like a tm struct. */
uint8_t dt_day;
uint8_t dt_hour;
uint8_t dt_minute;
uint8_t dt_second;
int8_t dt_gmtoff; /* GMT values -48 .. + 52 in 15 min intervals */
int8_t dt_gmtoff; /**< GMT values -48 .. + 52 in 15 minute
intervals */
} GNUC_PACKED;
typedef struct iso9660_dtime iso9660_dtime_t;
@@ -110,13 +117,20 @@ typedef struct iso9660_dtime iso9660_dtime_t;
/*! ISO-9660 Primary Volume Descriptor.
*/
struct iso9660_ltime {
char lt_year [_delta( 1, 4)]; /*! Add 1900 for Julian year */
char lt_month [_delta( 5, 6)]; /*! 1..12. Note starts at 1. */
char lt_year [_delta( 1, 4)]; /**< Add 1900 to value
for the Julian
year */
char lt_month [_delta( 5, 6)]; /**< Has value in range
1..12. Note starts
at 1, not 0 like a
tm struct. */
char lt_day [_delta( 7, 8)];
char lt_hour [_delta( 9, 10)];
char lt_minute [_delta( 11, 12)];
char lt_second [_delta( 13, 14)];
char lt_hsecond [_delta( 15, 16)]; /*! 1/100's of a second */
char lt_hsecond [_delta( 15, 16)]; /**<! The value is in
units of 1/100's of
a second */
int8_t lt_gmtoff [_delta( 17, 17)];
} GNUC_PACKED;
@@ -125,36 +139,47 @@ typedef struct iso9660_ltime iso9660_ltime_t;
/*! ISO-9660 Primary Volume Descriptor.
*/
struct iso9660_pvd {
uint8_t type; /* 711 */
uint8_t type; /**< 711 encoded */
char id[5];
uint8_t version; /* 711 */
uint8_t version; /**< 711 encoded */
char unused1[1];
char system_id[32]; /* achars */
char volume_id[32]; /* dchars */
char system_id[32]; /**< each char is an achar */
char volume_id[32]; /**< each char is a dchar */
char unused2[8];
uint64_t volume_space_size; /* 733 */
uint64_t volume_space_size; /**< 733 encoded */
char escape_sequences[32];
uint32_t volume_set_size; /* 723 */
uint32_t volume_sequence_number; /* 723 */
uint32_t logical_block_size; /* 723 */
uint64_t path_table_size; /* 733 */
uint32_t type_l_path_table; /* 731 */
uint32_t opt_type_l_path_table; /* 731 */
uint32_t type_m_path_table; /* 732 */
uint32_t opt_type_m_path_table; /* 732 */
char root_directory_record[34]; /* 9.1 */
char volume_set_id[128]; /* dchars */
char publisher_id[128]; /* achars */
char preparer_id[128]; /* achars */
char application_id[128]; /* achars */
char copyright_file_id[37]; /* 7.5 dchars */
char abstract_file_id[37]; /* 7.5 dchars */
char bibliographic_file_id[37]; /* 7.5 dchars */
iso9660_ltime_t creation_date; /* 8.4.26.1 */
iso9660_ltime_t modification_date; /* 8.4.26.1 */
iso9660_ltime_t expiration_date; /* 8.4.26.1 */
iso9660_ltime_t effective_date; /* 8.4.26.1 */
uint8_t file_structure_version; /* 711 */
uint32_t volume_set_size; /**< 723 encoded */
uint32_t volume_sequence_number; /**< 723 encoded */
uint32_t logical_block_size; /**< 723 encoded */
uint64_t path_table_size; /**< 733 encoded */
uint32_t type_l_path_table; /**< 731 encoded */
uint32_t opt_type_l_path_table; /**< 731 encoded */
uint32_t type_m_path_table; /**< 732 encoded */
uint32_t opt_type_m_path_table; /**< 732 encoded */
char root_directory_record[34]; /**< See section 9.1 of
ISO 9660 spec. */
char volume_set_id[128]; /**< dchars */
char publisher_id[128]; /**< achars */
char preparer_id[128]; /**< achars */
char application_id[128]; /**< achars */
char copyright_file_id[37]; /**< See section 7.5 of
ISO 9660 spec. Each char is
a dchar */
char abstract_file_id[37]; /**< See section 7.5 of
ISO 9660 spec. Each char is
a dchar */
char bibliographic_file_id[37]; /**< See section 7.5 of
ISO 9660 spec. Each char is
a dchar. */
iso9660_ltime_t creation_date; /**< See section 8.4.26.1 of
ISO 9660 spec. */
iso9660_ltime_t modification_date; /**< See section 8.4.26.1 of
ISO 9660 spec. */
iso9660_ltime_t expiration_date; /**< See section 8.4.26.1 of
ISO 9660 spec. */
iso9660_ltime_t effective_date; /**< See section 8.4.26.1 of
ISO 9660 spec. */
uint8_t file_structure_version; /**< 711 encoded */
char unused4[1];
char application_data[512];
char unused5[653];
@@ -179,30 +204,31 @@ typedef struct iso9660_stat iso9660_stat_t;
/*! Format of an ISO-9660 directory record */
struct iso9660_dir {
uint8_t length; /*! 711 */
uint8_t xa_length; /*! 711 */
uint64_t extent; /*! 733 */
uint64_t size; /*! 733 */
iso9660_dtime_t recording_time; /*! 7 by 711 */
uint8_t length; /*! 711 encoded */
uint8_t xa_length; /*! 711 encoded */
uint64_t extent; /*! 733 encoded */
uint64_t size; /*! 733 encoded */
iso9660_dtime_t recording_time; /*! 7 711-encoded units */
uint8_t file_flags;
uint8_t file_unit_size; /*! 711 */
uint8_t interleave_gap; /*! 711 */
uint32_t volume_sequence_number; /*! 723 */
uint8_t filename_len; /*! 711 */
uint8_t file_unit_size; /*! 711 encoded */
uint8_t interleave_gap; /*! 711 encoded */
uint32_t volume_sequence_number; /*! 723 encoded */
uint8_t filename_len; /*! 711 encoded */
char filename[EMPTY_ARRAY_SIZE];
} GNUC_PACKED;
/* The following structure is not part of ISO 9660. We just use it
for our own purposes for communicating info back that's pulled out.
/*! The iso9660_stat structure is not part of any ISO 9660 spec. We
just use it for our own purposes for communicating info back that's
pulled out.
*/
struct iso9660_stat { /* big endian!! */
enum { _STAT_FILE = 1, _STAT_DIR = 2 } type;
lsn_t lsn; /* start logical sector number */
uint32_t size; /* total size in bytes */
uint32_t secsize; /* number of sectors allocated */
iso9660_xa_t xa; /* XA attributes */
struct tm tm; /* time on entry */
lsn_t lsn; /**< start logical sector number */
uint32_t size; /**< total size in bytes */
uint32_t secsize; /**< number of sectors allocated */
iso9660_xa_t xa; /**< XA attributes */
struct tm tm; /**< time on entry */
} ;
PRAGMA_END_PACKED