From 70de5747997ee637dba6f817abccc56ec1340875 Mon Sep 17 00:00:00 2001
From: Andre Noll <maan@systemlinux.org>
Date: Sat, 15 Sep 2007 22:11:36 +0200
Subject: [PATCH 1/1] Add more error descriptions.

---
 error.h | 106 +++++++++++++++++++++++++++-----------------------------
 osl.c   |  18 +++++-----
 2 files changed, 61 insertions(+), 63 deletions(-)

diff --git a/error.h b/error.h
index 19f00d21..ee8cff34 100644
--- a/error.h
+++ b/error.h
@@ -96,62 +96,60 @@ extern const char **para_errlist[];
 
 #define OSL_ERRORS \
 	PARA_ERROR(OSL_OPENDIR, "can not open directory"), \
-	PARA_ERROR(OSL_CHDIR, "fixme"), \
-	PARA_ERROR(BAD_DB_DIR, "fixme"), \
-	PARA_ERROR(NO_COLUMN_DESC, "fixme"), \
-	PARA_ERROR(BAD_BASENAME, "fixme"), \
-	PARA_ERROR(BAD_STORAGE_TYPE, "fixme"), \
-	PARA_ERROR(BAD_STORAGE_FLAGS, "fixme"), \
-	PARA_ERROR(NO_COLUMN_NAME, "fixme"), \
-	PARA_ERROR(NO_COLUMNS, "fixme"), \
-	PARA_ERROR(BAD_COLUMN_NAME, "fixme"), \
-	PARA_ERROR(NO_UNIQUE_RBTREE_COLUMN, "fixme"), \
-	PARA_ERROR(NO_RBTREE_COL, "fixme"), \
-	PARA_ERROR(DUPLICATE_COL_NAME, "fixme"), \
-	PARA_ERROR(BAD_STORAGE_SIZE, "fixme"), \
-	PARA_ERROR(NO_COMPARE_FUNC, "fixme"), \
-	PARA_ERROR(NULL_OBJECT, "fixme"), \
-	PARA_ERROR(BAD_DATA_SIZE, "fixme"), \
+	PARA_ERROR(OSL_CHDIR, "failed to change directory"), \
+	PARA_ERROR(BAD_DB_DIR, "invalid database directory"), \
+	PARA_ERROR(NO_COLUMN_DESC, "missing column description"), \
+	PARA_ERROR(BAD_NAME, "invalid name for a column/table"), \
+	PARA_ERROR(BAD_STORAGE_TYPE, "invalid storage type"), \
+	PARA_ERROR(BAD_STORAGE_FLAGS, "invalid storage flags"), \
+	PARA_ERROR(NO_COLUMN_NAME, "missing column name"), \
+	PARA_ERROR(NO_COLUMNS, "at least one column required"), \
+	PARA_ERROR(BAD_COLUMN_NAME, "invalid name for a table column"), \
+	PARA_ERROR(NO_UNIQUE_RBTREE_COLUMN, "need at least one mapped column with OSL_UNIQE and OSL_RBTREE OSL"), \
+	PARA_ERROR(NO_RBTREE_COL, "at least one column needs an rbtree"), \
+	PARA_ERROR(DUPLICATE_COL_NAME, "column name given twice"), \
+	PARA_ERROR(BAD_STORAGE_SIZE, "invalid storage size"), \
+	PARA_ERROR(NO_COMPARE_FUNC, "missing compare function"), \
+	PARA_ERROR(BAD_DATA_SIZE, "wrong data size for fixed-size column"), \
 	PARA_ERROR(NOT_MAPPED, "file not mapped"), \
 	PARA_ERROR(ALREADY_MAPPED, "file already mapped"), \
-	PARA_ERROR(BAD_SIZE, "fixme"), \
-	PARA_ERROR(TRUNC, "fixme"), \
-	PARA_ERROR(UNLINK, "fixme"), \
+	PARA_ERROR(BAD_SIZE, "invalid size specified"), \
+	PARA_ERROR(TRUNC, "failed to truncate file"), \
+	PARA_ERROR(UNLINK, "failed to remove file"), \
 	PARA_ERROR(EXIST, "file or directory already exists"), \
 	PARA_ERROR(ISDIR, "error: is a directory"), \
 	PARA_ERROR(NOTDIR, "error: not a directory"), \
-	PARA_ERROR(NOENT, "fixme"), \
-	PARA_ERROR(OSL_PERM, "fixme"), \
+	PARA_ERROR(NOENT, "no such file or directory"), \
+	PARA_ERROR(OSL_PERM, "permission denied"), \
 	PARA_ERROR(BAD_TABLE, "table not open"), \
 	PARA_ERROR(BAD_TABLE_HEADER, "table header corruption"), \
 	PARA_ERROR(BAD_TABLE_DESC, "invalid table description"), \
 	PARA_ERROR(RB_KEY_EXISTS, "key already exists in rbtree"), \
 	PARA_ERROR(RB_KEY_NOT_FOUND, "key not found in rbtree"), \
-	PARA_ERROR(BAD_ID, "fixme"), \
-	PARA_ERROR(INDEX_CORRUPTION, "fixme"), \
-	PARA_ERROR(BAD_OFFSET, "fixme"), \
-	PARA_ERROR(INVALID_OBJECT, "fixme"), \
+	PARA_ERROR(BAD_ROW_NUM, "invalid row number"), \
+	PARA_ERROR(INDEX_CORRUPTION, "index corruption detected"), \
+	PARA_ERROR(INVALID_OBJECT, "reference to invalid object"), \
 	PARA_ERROR(MKDIR, "failed to create directory"), \
 	PARA_ERROR(OPEN, "failed to open file"), \
 	PARA_ERROR(STAT, "can not stat file"), \
 	PARA_ERROR(FSTAT, "fstat error"), \
-	PARA_ERROR(RENAME, "fixme"), \
+	PARA_ERROR(RENAME, "rename failed"), \
 	PARA_ERROR(EMPTY, "file empty"), \
-	PARA_ERROR(NOSPC, "fixme"), \
+	PARA_ERROR(NOSPC, "no space left on device"), \
 	PARA_ERROR(MMAP, "mmap error"), \
 	PARA_ERROR(MUNMAP, "munmap failed"), \
-	PARA_ERROR(WRITE, "fixme"), \
-	PARA_ERROR(LSEEK, "fixme"), \
-	PARA_ERROR(BUSY, "fixme"), \
-	PARA_ERROR(SHORT_TABLE, "fixme"), \
-	PARA_ERROR(NO_MAGIC, "fixme"), \
-	PARA_ERROR(VERSION_MISMATCH, "fixme"), \
-	PARA_ERROR(BAD_COLUMN_NUM, "fixme"), \
-	PARA_ERROR(BAD_TABLE_FLAGS, "fixme"), \
-	PARA_ERROR(RBTREE_EMPTY, "fixme"), \
-	PARA_ERROR(BAD_ROW, "fixme"), \
+	PARA_ERROR(WRITE, "write error"), \
+	PARA_ERROR(LSEEK, "lseek error"), \
+	PARA_ERROR(BUSY, "table is busy"), \
+	PARA_ERROR(SHORT_TABLE, "table too short"), \
+	PARA_ERROR(NO_MAGIC, "missing table header magic"), \
+	PARA_ERROR(VERSION_MISMATCH, "table version not suppoerted"), \
+	PARA_ERROR(BAD_COLUMN_NUM, "invalid column number"), \
+	PARA_ERROR(BAD_TABLE_FLAGS, "invalid flags in table description"), \
+	PARA_ERROR(RBTREE_EMPTY, "rbtree is empty"), \
+	PARA_ERROR(BAD_ROW, "invalid row"), \
 	PARA_ERROR(OSL_GETCWD, "can not get current working directory"), \
-	PARA_ERROR(OSL_LSTAT, "fixme"), \
+	PARA_ERROR(OSL_LSTAT, "lstat error"), \
 
 
 #define RBTREE_ERRORS \
@@ -165,21 +163,21 @@ extern const char **para_errlist[];
 
 
 #define MOOD_ERRORS \
-	PARA_ERROR(MOOD_SYNTAX, "fixme"), \
-	PARA_ERROR(MOOD_REGEX, "fixme"), \
-	PARA_ERROR(NO_MOOD, "fixme"), \
-	PARA_ERROR(MOOD_LOADED, "fixme"), \
-	PARA_ERROR(MOOD_BUSY, "fixme"), \
-	PARA_ERROR(NOT_ADMISSIBLE, "fixme"), \
-	PARA_ERROR(READ, "fixme"), \
-	PARA_ERROR(ATOL, "fixme"), \
+	PARA_ERROR(MOOD_SYNTAX, "mood syntax error"), \
+	PARA_ERROR(MOOD_REGEX, "invalid regular expression"), \
+	PARA_ERROR(NO_MOOD, "no mood available"), \
+	PARA_ERROR(MOOD_LOADED, "mood loaded"), \
+	PARA_ERROR(MOOD_BUSY, "mood is in use"), \
+	PARA_ERROR(NOT_ADMISSIBLE, "file is not admussible"), \
+	PARA_ERROR(READ, "read error"), \
+	PARA_ERROR(ATOL, "failed to convert to long"), \
 
 
 #define ATTRIBUTE_ERRORS \
-	PARA_ERROR(ATTR_SYNTAX, "fixme"), \
-	PARA_ERROR(ATTR_EXISTS, "fixme"), \
-	PARA_ERROR(ATTR_TABLE_FULL, "fixme"), \
-	PARA_ERROR(NO_ATTRIBUTES, "fixme"), \
+	PARA_ERROR(ATTR_SYNTAX, "attribute syntax error"), \
+	PARA_ERROR(ATTR_EXISTS, "attribute already exists"), \
+	PARA_ERROR(ATTR_TABLE_FULL, "attribute table full"), \
+	PARA_ERROR(NO_ATTRIBUTES, "no attributes defined yet"), \
 
 #define BLOB_ERRORS \
 	PARA_ERROR(BLOB_SYNTAX, "fixme"), \
@@ -195,11 +193,11 @@ extern const char **para_errlist[];
 
 #define AFT_ERRORS \
 	PARA_ERROR(BAD_AFSI, "invaid afs info"), \
-	PARA_ERROR(LOCALTIME, "fixme"), \
-	PARA_ERROR(STRFTIME, "fixme"), \
+	PARA_ERROR(LOCALTIME, "localtime() failed"), \
+	PARA_ERROR(STRFTIME, "strftime() failed"), \
 	PARA_ERROR(BAD_PATH, "invalid path"), \
-	PARA_ERROR(BAD_SORT, "fixme"), \
-	PARA_ERROR(FNMATCH, "fixme"), \
+	PARA_ERROR(BAD_SORT, "invalid sorting method"), \
+	PARA_ERROR(FNMATCH, "fnmatch error"), \
 	PARA_ERROR(NO_MATCH, "no matches"), \
 	PARA_ERROR(NO_AFHI, "audio format handler info required"), \
 	PARA_ERROR(AFT_SYNTAX, "audio file table syntax error"), \
diff --git a/osl.c b/osl.c
index 1587b04c..f49785cd 100644
--- a/osl.c
+++ b/osl.c
@@ -340,15 +340,15 @@ int para_mkdir(const char *path, mode_t mode)
 static int verify_basename(const char *name)
 {
 	if (!name)
-		return -E_BAD_BASENAME;
+		return -E_BAD_NAME;
 	if (!*name)
-		return -E_BAD_BASENAME;
+		return -E_BAD_NAME;
 	if (strchr(name, '/'))
-		return -E_BAD_BASENAME;
+		return -E_BAD_NAME;
 	if (!strcmp(name, ".."))
-		return -E_BAD_BASENAME;
+		return -E_BAD_NAME;
 	if (!strcmp(name, "."))
-		return -E_BAD_BASENAME;
+		return -E_BAD_NAME;
 	return 1;
 }
 
@@ -730,7 +730,7 @@ static int create_table_index(struct osl_table *t)
  * \param desc Pointer to the table description.
  *
  * \return Positive on success, negative on errors. Possible errors include: \p
- * E_BAD_TABLE_DESC, \p E_BAD_DB_DIR, \p E_BAD_BASENAME, \p E_NO_COMPARE_FUNC, \p
+ * E_BAD_TABLE_DESC, \p E_BAD_DB_DIR, \p E_BAD_NAME, \p E_NO_COMPARE_FUNC, \p
  * E_NO_COLUMN_NAME, \p E_DUPLICATE_COL_NAME, \p E_MKDIR, any errors returned
  * by para_open().
  */
@@ -945,7 +945,7 @@ err:	/* unmap what is already mapped */
  * of storage type \p OSL_MAPPED_STORAGE.
  *
  * \return Positive on success, negative on errors. Possible errors include:
- * \p E_BAD_ID, \p E_INVALID_OBJECT.
+ * \p E_BAD_ROW_NUM, \p E_INVALID_OBJECT.
  *
  * \sa osl_storage_type.
  */
@@ -959,7 +959,7 @@ int get_mapped_object(const struct osl_table *t, unsigned col_num,
 	int ret;
 
 	if (t->num_rows <= row_num)
-		return -E_BAD_ID;
+		return -E_BAD_ROW_NUM;
 	ret = get_cell_index(t, row_num, col_num, &cell_index);
 	if (ret < 0)
 		return ret;
@@ -1930,7 +1930,7 @@ int osl_update_object(struct osl_table *t, const struct osl_row *r,
 	}
 	if (cd->storage_flags & OSL_FIXED_SIZE) {
 		if (obj->size != cd->data_size)
-			return -E_BAD_SIZE;
+			return -E_BAD_DATA_SIZE;
 	}
 	remove_rb_node(t, col_num, r);
 	if (cd->storage_type == OSL_NO_STORAGE) { /* TODO: If fixed size, reuse object? */
-- 
2.39.2