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

Related to doxygen documentation.

Browse Source
This commit is contained in:
rocky
2003-11-17 12:06:56 +00:00
parent 9625eed6f3
commit 24b74eb08b
8 changed files with 94 additions and 38 deletions
Download Patch File Download Diff File Expand all files Collapse all files

5
doc/Makefile.am
View File

@@ -1,4 +1,4 @@
# $Id: Makefile.am,v 1.3 2003/11/16 19:30:45 rocky Exp $ # $Id: Makefile.am,v 1.4 2003/11/17 12:06:56 rocky Exp $
# #
# Copyright (C) 2003 Rocky Bernstein <rocky@panix.com> # Copyright (C) 2003 Rocky Bernstein <rocky@panix.com>
# #
@@ -19,6 +19,9 @@
EXTRA_DIST = doxygen/Doxyfile doxygen/run_doxygen EXTRA_DIST = doxygen/Doxyfile doxygen/run_doxygen
info_TEXINFOS = libcdio.texi info_TEXINFOS = libcdio.texi
reference:
-( cd ${top_srcdir} && $(MAKE) doxygen )
pdf: libcdio.pdf pdf: libcdio.pdf
txt: libcdio.txt txt: libcdio.txt

10
include/cdio/cd_types.h
View File

@@ -1,5 +1,5 @@
/* /*
$Id: cd_types.h,v 1.6 2003/11/05 04:12:58 rocky Exp $ $Id: cd_types.h,v 1.7 2003/11/17 12:06:57 rocky Exp $
Copyright (C) 2003 Rocky Bernstein <rocky@panix.com> Copyright (C) 2003 Rocky Bernstein <rocky@panix.com>
Copyright (C) 1996,1997,1998 Gerd Knorr <kraxel@bytesex.org> Copyright (C) 1996,1997,1998 Gerd Knorr <kraxel@bytesex.org>
@@ -20,6 +20,12 @@
Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
*/ */
/** \file cd_types.h
* \brief Header for routines which automatically determine the Compact Disc
* format and possibly filesystem on the CD.
*
*/
#ifndef __CDIO_CD_TYPES_H__ #ifndef __CDIO_CD_TYPES_H__
#define __CDIO_CD_TYPES_H__ #define __CDIO_CD_TYPES_H__
@@ -115,7 +121,7 @@ typedef struct
/** /**
* Try to determine what kind of CD-image and/or filesystem we * Try to determine what kind of CD-image and/or filesystem we
* have at track track_num. Return information about the CD image * have at track track_num. Return information about the CD image
* is returned in cdio_analysis and the return value. * is returned in iso_analysis and the return value.
*/ */
cdio_fs_anal_t cdio_guess_cd_type(const CdIo *cdio, int start_session, cdio_fs_anal_t cdio_guess_cd_type(const CdIo *cdio, int start_session,
track_t track_num, track_t track_num,

43
include/cdio/cdio.h
View File

@@ -1,5 +1,5 @@
/* -*- c -*- /* -*- c -*-
$Id: cdio.h,v 1.33 2003/11/05 12:40:34 rocky Exp $ $Id: cdio.h,v 1.34 2003/11/17 12:06:57 rocky Exp $
Copyright (C) 2001 Herbert Valerio Riedel <hvr@gnu.org> Copyright (C) 2001 Herbert Valerio Riedel <hvr@gnu.org>
Copyright (C) 2003 Rocky Bernstein <rocky@panix.com> Copyright (C) 2003 Rocky Bernstein <rocky@panix.com>
@@ -19,7 +19,9 @@
Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
*/ */
/** \file cdio.h - Public CD Input and Control Interface . */ /** \file cdio.h
* \brief The top-level header for libcdio: the CD Input and Control library.
*/
#ifndef __CDIO_H__ #ifndef __CDIO_H__
@@ -46,7 +48,7 @@
#define CDIO_SRC_IS_DISK_IMAGE_MASK 0x0001 /**< Read source is a CD image. */ #define CDIO_SRC_IS_DISK_IMAGE_MASK 0x0001 /**< Read source is a CD image. */
#define CDIO_SRC_IS_DEVICE_MASK 0x0002 /**< Read source is a CD device. */ #define CDIO_SRC_IS_DEVICE_MASK 0x0002 /**< Read source is a CD device. */
#define CDIO_SRC_IS_SCSI_MASK 0x0004 #define CDIO_SRC_IS_SCSI_MASK 0x0004
#define CDIO_SRC_IS_NATIVE_MASK 0x0008 #define CDIO_SRC_IS_NATIVE_MASK 0x0008
#ifdef __cplusplus #ifdef __cplusplus
@@ -392,29 +394,40 @@ extern "C" {
the some sort of device name. the some sort of device name.
NULL is returned on error or there is no BSDI driver. NULL is returned on error or there is no BSDI driver.
@see cdio_open
*/ */
CdIo * cdio_open_bsdi (const char *source_name); CdIo * cdio_open_bsdi (const char *source_name);
/*! Return a string containing the default device name that the /*! Return a string containing the default device name that the
BSDI driver would use when none is specified. BSDI driver would use when none is specified.
NULL is returned on error or there is no CD-ROM device NULL is returned on error or there is no CD-ROM device.
@see cdio_open_cd
@see cdio_open
*/ */
char * cdio_get_default_device_bsdi(void); char * cdio_get_default_device_bsdi(void);
/*! Return a list of all of the CD-ROM devices that the BSDI driver
can find.
*/
char **cdio_get_devices_bsdi(void); char **cdio_get_devices_bsdi(void);
/*! Set up CD-ROM for reading using the FreeBSD driver. The device_name is /*! Set up CD-ROM for reading using the FreeBSD driver. The device_name is
the some sort of device name. the some sort of device name.
NULL is returned on error or there is no FreeBSD driver. NULL is returned on error or there is no FreeBSD driver.
@see cdio_open_cd
@see cdio_open
*/ */
CdIo * cdio_open_freebsd (const char *source_name); CdIo * cdio_open_freebsd (const char *source_name);
/*! Return a string containing the default device name that the /*! Return a string containing the default device name that the
FreeBSD driver would use when none is specified. FreeBSD driver would use when none is specified.
NULL is returned on error or there is no CD-ROM device NULL is returned on error or there is no CD-ROM device.
*/ */
char * cdio_get_default_device_freebsd(void); char * cdio_get_default_device_freebsd(void);
@@ -434,7 +447,10 @@ extern "C" {
GNU/Linux driver would use when none is specified. A scan is made GNU/Linux driver would use when none is specified. A scan is made
for CD-ROM drives with CDs in them. for CD-ROM drives with CDs in them.
NULL is returned on error or there is no CD-ROM device NULL is returned on error or there is no CD-ROM device.
@see cdio_open_cd
@see cdio_open
*/ */
char * cdio_get_default_device_linux(void); char * cdio_get_default_device_linux(void);
@@ -454,7 +470,10 @@ extern "C" {
Solaris driver would use when none is specified. A scan is made Solaris driver would use when none is specified. A scan is made
for CD-ROM drives with CDs in them. for CD-ROM drives with CDs in them.
NULL is returned on error or there is no CD-ROM device NULL is returned on error or there is no CD-ROM device.
@see cdio_open_cd
@see cdio_open
*/ */
char * cdio_get_default_device_solaris(void); char * cdio_get_default_device_solaris(void);
@@ -467,6 +486,9 @@ extern "C" {
device_name is the some sort of device name. device_name is the some sort of device name.
NULL is returned on error or there is no OSX driver. NULL is returned on error or there is no OSX driver.
@see cdio_open_cd
@see cdio_open
*/ */
CdIo * cdio_open_osx (const char *source_name); CdIo * cdio_open_osx (const char *source_name);
@@ -494,7 +516,10 @@ extern "C" {
Win32 driver would use when none is specified. A scan is made Win32 driver would use when none is specified. A scan is made
for CD-ROM drives with CDs in them. for CD-ROM drives with CDs in them.
NULL is returned on error or there is no CD-ROM device NULL is returned on error or there is no CD-ROM device.
@see cdio_open_cd
@see cdio_open
*/ */
char * cdio_get_default_device_win32(void); char * cdio_get_default_device_win32(void);
@@ -511,7 +536,7 @@ extern "C" {
NRG driver would use when none is specified. A scan is made NRG driver would use when none is specified. A scan is made
for NRG disk images in the current directory.. for NRG disk images in the current directory..
NULL is returned on error or there is no CD-ROM device NULL is returned on error or there is no CD-ROM device.
*/ */
char * cdio_get_default_device_nrg(void); char * cdio_get_default_device_nrg(void);

6
include/cdio/iso9660.h
View File

@@ -1,5 +1,5 @@
/* /*
$Id: iso9660.h,v 1.31 2003/11/16 19:30:45 rocky Exp $ $Id: iso9660.h,v 1.32 2003/11/17 12:06:57 rocky Exp $
Copyright (C) 2000 Herbert Valerio Riedel <hvr@gnu.org> Copyright (C) 2000 Herbert Valerio Riedel <hvr@gnu.org>
Copyright (C) 2003 Rocky Bernstein <rocky@panix.com> Copyright (C) 2003 Rocky Bernstein <rocky@panix.com>
@@ -24,8 +24,8 @@
Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
*/ */
/*! /*!
* \file iso9660.h - Assorted structure definitions and typecasts. * \file iso9660.h
* specific for the ISO 9660 filesystem. * \brief Header for libiso9660: the ISO-9660 filesystem library.
*/ */

7
include/cdio/logging.h
View File

@@ -1,5 +1,5 @@
/* /*
$Id: logging.h,v 1.5 2003/11/04 12:28:08 rocky Exp $ $Id: logging.h,v 1.6 2003/11/17 12:06:58 rocky Exp $
Copyright (C) 2000, Herbert Valerio Riedel <hvr@gnu.org> Copyright (C) 2000, Herbert Valerio Riedel <hvr@gnu.org>
Copyright (C) 2003, Rocky Bernstein <rocky@panix.com> Copyright (C) 2003, Rocky Bernstein <rocky@panix.com>
@@ -18,6 +18,11 @@
along with this program; if not, write to the Free Software along with this program; if not, write to the Free Software
Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
*/ */
/** \file logging.h
* \brief Header to control logging and level of detail of output.
*
*/
#ifndef __LOGGING_H__ #ifndef __LOGGING_H__
#define __LOGGING_H__ #define __LOGGING_H__

6
include/cdio/sector.h
View File

@@ -1,5 +1,5 @@
/* /*
$Id: sector.h,v 1.7 2003/11/05 12:40:35 rocky Exp $ $Id: sector.h,v 1.8 2003/11/17 12:06:58 rocky Exp $
Copyright (C) 2000 Herbert Valerio Riedel <hvr@gnu.org> Copyright (C) 2000 Herbert Valerio Riedel <hvr@gnu.org>
Copyright (C) 2003 Rocky Bernstein <rocky@panix.com> Copyright (C) 2003 Rocky Bernstein <rocky@panix.com>
@@ -19,8 +19,8 @@
Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
*/ */
/*! /*!
\file sector.h - Things related to CDROM layout. Sector sizes, \file sector.h
MSFs, LBAs, \brief Things related to CD-ROM layout: tracks, sector sizes, MSFs, LBAs.
A CD-ROM physical sector size is 2048, 2052, 2056, 2324, 2332, 2336, A CD-ROM physical sector size is 2048, 2052, 2056, 2324, 2332, 2336,
2340, or 2352 bytes long. 2340, or 2352 bytes long.

7
include/cdio/types.h
View File

@@ -1,5 +1,5 @@
/* /*
$Id: types.h,v 1.7 2003/09/28 17:14:20 rocky Exp $ $Id: types.h,v 1.8 2003/11/17 12:06:58 rocky Exp $
Copyright (C) 2000 Herbert Valerio Riedel <hvr@gnu.org> Copyright (C) 2000 Herbert Valerio Riedel <hvr@gnu.org>
Copyright (C) 2002,2003 Rocky Bernstein <rocky@panix.com> Copyright (C) 2002,2003 Rocky Bernstein <rocky@panix.com>
@@ -18,6 +18,11 @@
along with this program; if not, write to the Free Software along with this program; if not, write to the Free Software
Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
*/ */
/** \file types.h
* \brief Common type definitions used pervasively in libcdio.
*/
#ifndef __CDIO_TYPES_H__ #ifndef __CDIO_TYPES_H__
#define __CDIO_TYPES_H__ #define __CDIO_TYPES_H__

48
include/cdio/xa.h
View File

@@ -1,5 +1,5 @@
/* /*
$Id: xa.h,v 1.5 2003/09/21 01:14:30 rocky Exp $ $Id: xa.h,v 1.6 2003/11/17 12:06:58 rocky Exp $
Copyright (C) 2000 Herbert Valerio Riedel <hvr@gnu.org> Copyright (C) 2000 Herbert Valerio Riedel <hvr@gnu.org>
Copyright (C) 2003 Rocky Bernstein <rocky@panix.com> Copyright (C) 2003 Rocky Bernstein <rocky@panix.com>
@@ -24,6 +24,11 @@
along with this program; if not, write to the Free Software along with this program; if not, write to the Free Software
Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
*/ */
/*!
\file xa.h
\brief Things related to the ISO-9660 XA (Extended Attributes) format
*/
#ifndef __CDIO_XA_H__ #ifndef __CDIO_XA_H__
#define __CDIO_XA_H__ #define __CDIO_XA_H__
@@ -34,17 +39,17 @@
#define ISO_XA_MARKER_OFFSET 1024 #define ISO_XA_MARKER_OFFSET 1024
/* XA attribute definitions */ /* XA attribute definitions */
#define XA_PERM_RSYS 0x0001 /* System Group Read */ #define XA_PERM_RSYS 0x0001 /**< System Group Read */
#define XA_PERM_XSYS 0x0004 /* System Group Execute */ #define XA_PERM_XSYS 0x0004 /**< System Group Execute */
#define XA_PERM_RUSR 0x0010 /* User (owner) Read */ #define XA_PERM_RUSR 0x0010 /**< User (owner) Read */
#define XA_PERM_XUSR 0x0040 /* User (owner) Execute */ #define XA_PERM_XUSR 0x0040 /**< User (owner) Execute */
#define XA_PERM_RGRP 0x0100 /* Group Read */ #define XA_PERM_RGRP 0x0100 /**< Group Read */
#define XA_PERM_XGRP 0x0400 /* Group Execute */ #define XA_PERM_XGRP 0x0400 /**< Group Execute */
#define XA_PERM_ROTH 0x1000 /* Other (world) Read */ #define XA_PERM_ROTH 0x1000 /**< Other (world) Read */
#define XA_PERM_XOTH 0x4000 /* Other (world) Execute */ #define XA_PERM_XOTH 0x4000 /**< Other (world) Execute */
#define XA_ATTR_MODE2FORM1 (1 << 11) #define XA_ATTR_MODE2FORM1 (1 << 11)
#define XA_ATTR_MODE2FORM2 (1 << 12) #define XA_ATTR_MODE2FORM2 (1 << 12)
@@ -61,17 +66,18 @@
#define XA_FORM1_FILE (XA_ATTR_MODE2FORM1 | XA_PERM_ALL_ALL) #define XA_FORM1_FILE (XA_ATTR_MODE2FORM1 | XA_PERM_ALL_ALL)
#define XA_FORM2_FILE (XA_ATTR_MODE2FORM2 | XA_PERM_ALL_ALL) #define XA_FORM2_FILE (XA_ATTR_MODE2FORM2 | XA_PERM_ALL_ALL)
/* /*!
* Extended Attributes record according to Yellow Book. * An "Extended Attributes" record according to the Philips Yellow Book.
* Note structure is big-endian.
*/ */
typedef struct iso9660_xa /* big endian!! */ typedef struct iso9660_xa
{ {
uint16_t group_id; /* 0 */ uint16_t group_id; /**< 0 */
uint16_t user_id; /* 0 */ uint16_t user_id; /**< 0 */
uint16_t attributes; /* XA_ATTR_ */ uint16_t attributes; /**< XA_ATTR_ */
uint8_t signature[2]; /* { 'X', 'A' } */ uint8_t signature[2]; /**< { 'X', 'A' } */
uint8_t filenum; /* file number, see also XA subheader */ uint8_t filenum; /**< file number, see also XA subheader */
uint8_t reserved[5]; /* zero */ uint8_t reserved[5]; /**< zero */
} iso9660_xa_t GNUC_PACKED; } iso9660_xa_t GNUC_PACKED;
@@ -106,6 +112,12 @@ typedef struct iso9660_xa /* big endian!! */
const char * const char *
iso9660_get_xa_attr_str (uint16_t xa_attr); iso9660_get_xa_attr_str (uint16_t xa_attr);
/*!
Allocates and initalizes a new iso9600_xa_t variable and returns
it. The caller should free the returned result.
@see iso9660_xa
*/
iso9660_xa_t * iso9660_xa_t *
iso9660_xa_init (iso9660_xa_t *_xa, uint16_t uid, uint16_t gid, uint16_t attr, iso9660_xa_init (iso9660_xa_t *_xa, uint16_t uid, uint16_t gid, uint16_t attr,
uint8_t filenum); uint8_t filenum);