diff --git a/libisofs/error.h b/libisofs/error.h deleted file mode 100644 index 5f2b4ba..0000000 --- a/libisofs/error.h +++ /dev/null @@ -1,221 +0,0 @@ -/* - * Copyright (c) 2007 Vreixo Formoso - * - * This file is part of the libisofs project; you can redistribute it and/or - * modify it under the terms of the GNU General Public License version 2 as - * published by the Free Software Foundation. See COPYING file for details. - */ -#ifndef LIBISO_ERROR_H_ -#define LIBISO_ERROR_H_ - -/* - * Error codes and return values for libisofs. - */ - -/* - * error codes are 32 bit numbers, that follow the following conventions: - * - * bit 31 (MSB) -> 1 (to make the value always negative) - * bits 30-24 -> Encoded severity (Use ISO_ERR_SEV to translate an error code - * to a LIBISO_MSGS_SEV_* constant) - * = 0x10 -> DEBUG - * = 0x20 -> UPDATE - * = 0x30 -> NOTE - * = 0x40 -> HINT - * = 0x50 -> WARNING - * = 0x60 -> SORRY - * = 0x68 -> FAILURE - * = 0x70 -> FATAL - * = 0x71 -> ABORT - * bits 23-20 -> Encoded priority (Use ISO_ERR_PRIO to translate an error code - * to a LIBISO_MSGS_PRIO_* constant) - * = 0x0 -> ZERO - * = 0x1 -> LOW - * = 0x2 -> MEDIUM - * = 0x3 -> HIGH - * bits 19-16 -> Reserved for future usage (maybe message ranges) - * bits 15-0 -> Error code - */ - -#define ISO_ERR_SEV(e) (e & 0x7F000000) -#define ISO_ERR_PRIO(e) ((e & 0x00F00000) << 8) -#define ISO_ERR_CODE(e) (e & 0x0000FFFF) - -/** successfully execution */ -#define ISO_SUCCESS 1 - -/** - * special return value, it could be or not an error depending on the - * context. - */ -#define ISO_NONE 0 - -/** Operation canceled (FAILURE,HIGH, -1) */ -#define ISO_CANCELED 0xE830FFFF - -/** Unknown or unexpected fatal error (FATAL,HIGH, -2) */ -#define ISO_FATAL_ERROR 0xF030FFFE - -/** Unknown or unexpected error (FAILURE,HIGH, -3) */ -#define ISO_ERROR 0xE830FFFD - -/** Internal programming error. Please report this bug (FATAL,HIGH, -4) */ -#define ISO_ASSERT_FAILURE 0xF030FFFC - -/** - * NULL pointer as value for an arg. that doesn't allow NULL (FAILURE,HIGH, -5) - */ -#define ISO_NULL_POINTER 0xE830FFFB - -/** Memory allocation error (FATAL,HIGH, -6) */ -#define ISO_OUT_OF_MEM 0xF030FFFA - -/** Interrupted by a signal (FATAL,HIGH, -7) */ -#define ISO_INTERRUPTED 0xF030FFF9 - -/** Invalid parameter value (FAILURE,HIGH, -8) */ -#define ISO_WRONG_ARG_VALUE 0xE830FFF8 - -/** Can't create a needed thread (FATAL,HIGH, -9) */ -#define ISO_THREAD_ERROR 0xF030FFF7 - -/** Write error (FAILURE,HIGH, -10) */ -#define ISO_WRITE_ERROR 0xE830FFF6 - -/** Buffer read error (FAILURE,HIGH, -11) */ -#define ISO_BUF_READ_ERROR 0xE830FFF5 - -/** Trying to add to a dir a node already added to a dir (FAILURE,HIGH, -64) */ -#define ISO_NODE_ALREADY_ADDED 0xE830FFC0 - -/** Node with same name already exists (FAILURE,HIGH, -65) */ -#define ISO_NODE_NAME_NOT_UNIQUE 0xE830FFBF - -/** Trying to remove a node that was not added to dir (FAILURE,HIGH, -65) */ -#define ISO_NODE_NOT_ADDED_TO_DIR 0xE830FFBE - -/** A requested node does not exists (FAILURE,HIGH, -66) */ -#define ISO_NODE_DOESNT_EXIST 0xE830FFBD - -/** - * Try to set the boot image of an already bootable image (FAILURE,HIGH, -67) - */ -#define ISO_IMAGE_ALREADY_BOOTABLE 0xE830FFBC - -/** Trying to use an invalid file as boot image (FAILURE,HIGH, -68) */ -#define ISO_BOOT_IMAGE_NOT_VALID 0xE830FFBB - -/** - * Error on file operation (FAILURE,HIGH, -128) - * (take a look at more specified error codes below) - */ -#define ISO_FILE_ERROR 0xE830FF80 - -/** Trying to open an already openned file (FAILURE,HIGH, -129) */ -#define ISO_FILE_ALREADY_OPENNED 0xE830FF7F - -/** Access to file is not allowed (FAILURE,HIGH, -130) */ -#define ISO_FILE_ACCESS_DENIED 0xE830FF7E - -/** Incorrect path to file (FAILURE,HIGH, -131) */ -#define ISO_FILE_BAD_PATH 0xE830FF7D - -/** The file does not exists in the filesystem (FAILURE,HIGH, -132) */ -#define ISO_FILE_DOESNT_EXIST 0xE830FF7C - -/** Trying to read or close a file not openned (FAILURE,HIGH, -133) */ -#define ISO_FILE_NOT_OPENNED 0xE830FF7B - -/** Directory used where no dir is expected (FAILURE,HIGH, -134) */ -#define ISO_FILE_IS_DIR 0xE830FF7A - -/** Read error (FAILURE,HIGH, -135) */ -#define ISO_FILE_READ_ERROR 0xE830FF79 - -/** Not dir used where a dir is expected (FAILURE,HIGH, -136) */ -#define ISO_FILE_IS_NOT_DIR 0xE830FF78 - -/** Not symlink used where a symlink is expected (FAILURE,HIGH, -137) */ -#define ISO_FILE_IS_NOT_SYMLINK 0xE830FF77 - -/** Can't seek to specified location (FAILURE,HIGH, -138) */ -#define ISO_FILE_SEEK_ERROR 0xE830FF76 - -/** File not supported in ECMA-119 tree and thus ignored (HINT,MEDIUM, -139) */ -#define ISO_FILE_IGNORED 0xC020FF75 - -/* A file is bigger than supported by used standard (HINT,MEDIUM, -140) */ -#define ISO_FILE_TOO_BIG 0xC020FF74 - -/* File read error during image creations (SORRY,HIGH, -141) */ -#define ISO_FILE_CANT_WRITE 0xE030FF73 - -/* Can't convert filename to requested charset (HINT,MEDIUM, -142) */ -#define ISO_FILENAME_WRONG_CHARSET 0xC020FF72 - -/* File can't be added to the tree (SORRY,HIGH, -143) */ -#define ISO_FILE_CANT_ADD 0xE030FF71 - -/** - * File path break specification constraints and will be ignored - * (HINT,MEDIUM, -141) - */ -#define ISO_FILE_IMGPATH_WRONG 0xC020FF73 - -/** Charset conversion error (FAILURE,HIGH, -256) */ -#define ISO_CHARSET_CONV_ERROR 0xE830FF00 - -/** - * Too much files to mangle, i.e. we cannot guarantee unique file names - * (FAILURE,HIGH, -257) - */ -#define ISO_MANGLE_TOO_MUCH_FILES 0xE830FEFF - -/* image related errors */ - -/** - * Wrong or damaged Primary Volume Descriptor (FAILURE,HIGH, -320) - * This could mean that the file is not a valid ISO image. - */ -#define ISO_WRONG_PVD 0xE830FEC0 - -/** Wrong or damaged RR entry (SORRY,HIGH, -321) */ -#define ISO_WRONG_RR 0xE030FEBF - -/** Unsupported RR feature (SORRY,HIGH, -322) */ -#define ISO_UNSUPPORTED_RR 0xE030FEBE - -/** Wrong or damaged ECMA-119 (FAILURE,HIGH, -323) */ -#define ISO_WRONG_ECMA119 0xE830FEBD - -/** Unsupported ECMA-119 feature (FAILURE,HIGH, -324) */ -#define ISO_UNSUPPORTED_ECMA119 0xE830FEBC - -/** Wrong or damaged El-Torito catalog (SORRY,HIGH, -325) */ -#define ISO_WRONG_EL_TORITO 0xE030FEBB - -/** Unsupported El-Torito feature (SORRY,HIGH, -326) */ -#define ISO_UNSUPPORTED_EL_TORITO 0xE030FEBA - -/** Can't patch an isolinux boot image (SORRY,HIGH, -327) */ -#define ISO_ISOLINUX_CANT_PATCH 0xE030FEB9 - -/** Unsupported SUSP feature (SORRY,HIGH, -328) */ -#define ISO_UNSUPPORTED_SUSP 0xE030FEB8 - -/** Error on a RR entry that can be ignored (WARNING,MEDIUM, -329) */ -#define ISO_WRONG_RR_WARN 0xD020FEB7 - -/** Error on a RR entry that can be ignored (HINT,MEDIUM, -330) */ -#define ISO_SUSP_UNHANDLED 0xC020FEB6 - -/** Multiple ER SUSP entries found (WARNING,MEDIUM, -331) */ -#define ISO_SUSP_MULTIPLE_ER 0xD020FEB5 - -/** Unsupported volume descriptor found (HINT,MEDIUM, -332) */ -#define ISO_UNSUPPORTED_VD 0xC020FEB4 - -/** El-Torito related warning (WARNING,MEDIUM, -333) */ -#define ISO_EL_TORITO_WARN 0xD020FEB3 - -#endif /*LIBISO_ERROR_H_*/ diff --git a/libisofs/libisofs.h b/libisofs/libisofs.h index 2fdca25..ef81ac9 100644 --- a/libisofs/libisofs.h +++ b/libisofs/libisofs.h @@ -1260,11 +1260,10 @@ const char *iso_image_get_biblio_file_id(const IsoImage *image); * @return * 1 on success, < 0 on error */ -int - iso_image_set_boot_image(IsoImage *image, const char *image_path, - enum eltorito_boot_media_type type, - const char *catalog_path, - ElToritoBootImage **boot); +int iso_image_set_boot_image(IsoImage *image, const char *image_path, + enum eltorito_boot_media_type type, + const char *catalog_path, + ElToritoBootImage **boot); /* TODO #00026 : add support for "hidden" bootable images. */ @@ -1497,9 +1496,8 @@ void iso_node_set_hidden(IsoNode *node, int hide_attrs); * ISO_NODE_NAME_NOT_UNIQUE, a node with same name already exists * ISO_WRONG_ARG_VALUE, if child == dir, or replace != (0,1) */ -int - iso_dir_add_node(IsoDir *dir, IsoNode *child, - enum iso_replace_mode replace); +int iso_dir_add_node(IsoDir *dir, IsoNode *child, + enum iso_replace_mode replace); /** * Locate a node inside a given dir. @@ -1937,7 +1935,8 @@ int iso_tree_remove_exclude(IsoImage *image, const char *path); * continue, < 0 to abort the process * NULL is allowed if you don't want any callback. */ -void iso_tree_set_report_callback(IsoImage *image, int (*report)(IsoImage*, IsoFileSource*)); +void iso_tree_set_report_callback(IsoImage *image, + int (*report)(IsoImage*, IsoFileSource*)); /** * Add a new node to the image tree, from an existing file. @@ -2340,7 +2339,10 @@ void iso_filesystem_unref(IsoFilesystem *fs); * @param opts * Image read options * @param msgid - * TODO + * An image identifer, obtained with iso_image_get_msg_id(), used to + * associated messages issued by the filesystem implementation with an + * existent image. If you are not using this filesystem in relation with + * any image context, just use 0x1fffff as the value for this parameter. * @param fs * Will be filled with a pointer to the filesystem that can be used * to access image contents.