It contains handy functions that don't exist on some systems.
For now: xbt_getline (moved from xbt/str) and xbt_dirname (new function).
- Portability support
- \ref XBT_syscall
- \ref XBT_str
+ - \ref XBT_file
- Grounding features
- \ref XBT_ex
- \ref XBT_log
#include <xbt/misc.h>
#include <xbt/sysdep.h>
#include <xbt/str.h>
+#include <xbt/file.h>
#include <xbt/function_types.h>
#include <xbt/asserts.h>
--- /dev/null
+/* str.h - XBT string related functions. */
+
+/* Copyright (c) 2007-2015. The SimGrid Team.
+ * All rights reserved. */
+
+/* This program is free software; you can redistribute it and/or modify it
+ * under the terms of the license (GNU LGPL) which comes with this package. */
+
+#ifndef XBT_FILE_H
+#define XBT_FILE_H
+
+#include <stdint.h> /* ssize_t */
+#include <stdarg.h> /* va_* */
+#include <stdio.h> /* FILE */
+#include <stdlib.h> /* size_t, ssize_t */
+#include "xbt/misc.h"
+#include "xbt/dynar.h"
+#include "xbt/dict.h"
+#include "simgrid_config.h" /* FILE for getline */
+
+SG_BEGIN_DECL()
+
+/** @addtogroup XBT_file
+ * @brief File manipulation functions
+ *
+ * This module redefine some quite classical functions (such as xbt_getline() or xbt_dirname()) for the platforms
+ * lacking them.
+ * @{
+ */
+/* Our own implementation of getline, mainly useful on the platforms not enjoying this function */
+XBT_PUBLIC(ssize_t) xbt_getline(char **lineptr, size_t * n, FILE * stream);
+
+/* Our own implementation of dirname, that does not exist on windows */
+XBT_PUBLIC(char *) xbt_dirname(const char *path);
+
+/**@}*/
+
+SG_END_DECL()
+#endif /* XBT_FILE_H */
#ifndef XBT_STR_H
#define XBT_STR_H
-#include <stdint.h> /* ssize_t */
#include <stdarg.h> /* va_* */
#include <stdio.h> /* FILE */
-#include <stdlib.h> /* size_t, ssize_t */
#include "xbt/misc.h"
#include "xbt/dynar.h"
#include "xbt/dict.h"
-#include "simgrid_config.h" /* FILE for getline */
SG_BEGIN_DECL()
/** @addtogroup XBT_str
* @brief String manipulation functions
*
- * This module defines several string related functions. We redefine some quite classical
- * functions on the platforms were they are not nativaly defined (such as xbt_getline() or
- * asprintf()), while some other are a bit more exotic.
+ * This module defines several string related functions. Looking at the diversity of string
+ * manipulation functions that are provided, you can see that several SimGrid core developers
+ * actually like Perl.
* @{
*/
-/* Our own implementation of getline, mainly useful on the platforms not enjoying this function */
-XBT_PUBLIC(ssize_t) xbt_getline(char **lineptr, size_t * n, FILE * stream);
/* Trim related functions */
XBT_PUBLIC(void) xbt_str_rtrim(char *s, const char *char_list);
#include "storage_interface.hpp"
#include "surf_private.h"
+#include "xbt/file.h" /* xbt_getline */
XBT_LOG_NEW_DEFAULT_SUBCATEGORY(surf_storage, surf,
"Logging specific to the SURF storage module");
#include <errno.h>
#include <math.h>
#include <stdarg.h> /* va_arg */
-#ifndef _MSC_VER
-#include <libgen.h>
-#endif
#include "xbt/misc.h"
#include "xbt/log.h"
#include "xbt/str.h"
+#include "xbt/file.h"
#include "xbt/dict.h"
#include "surf/surfxml_parse.h"
#include "surf/surf_private.h"
if (!surf_parsed_filename_stack)
surf_parsed_filename_stack = xbt_dynar_new(sizeof(char *), &xbt_free_ref);
-#ifdef _MSC_VER
- /* There is no dirname on windows... */
- char drive[_MAX_DRIVE];
- char dir[_MAX_DIR];
- errno_t err;
- err = _splitpath_s(file, drive, _MAX_DRIVE, dir, _MAX_DIR, NULL,0, NULL,0);
- char *dir = bprintf("%s%s",drive,dir);
-#else
- surf_parsed_filename = xbt_strdup(file);
- char *dir = dirname(surf_parsed_filename);
-#endif
+ char *dir = xbt_dirname(file);
xbt_dynar_push(surf_path, &dir);
surf_file_to_parse = surf_fopen(file, "r");
#include "xbt/dict.h"
#include "xbt/heap.h"
#include "xbt/str.h"
-
+#include "xbt/file.h"
--- /dev/null
+/* xbt_os_file.c -- portable interface to file-related functions */
+
+/* Copyright (c) 2007-2010, 2012-2015. The SimGrid Team.
+ * All rights reserved. */
+
+/* This program is free software; you can redistribute it and/or modify it
+ * under the terms of the license (GNU LGPL) which comes with this package. */
+
+#include "xbt/sysdep.h"
+#include "xbt/file.h" /* this module */
+#include "xbt/log.h"
+#include "portable.h"
+
+#ifndef _MSC_VER
+#include "libgen.h" /* POSIX dirname */
+#endif
+
+/** @brief Get a single line from the stream (reimplementation of the GNU getline)
+ *
+ * This is a reimplementation of the GNU getline function, so that our code don't depends on the GNU libc.
+ *
+ * xbt_getline() reads an entire line from stream, storing the address of the
+ * buffer containing the text into *buf. The buffer is null-terminated and
+ * includes the newline character, if one was found.
+ *
+ * If *buf is NULL, then xbt_getline() will allocate a buffer for storing the
+ * line, which should be freed by the user program.
+ *
+ * Alternatively, before calling xbt_getline(), *buf can contain a pointer to a
+ * malloc()-allocated buffer *n bytes in size. If the buffer is not large
+ * enough to hold the line, xbt_getline() resizes it with realloc(), updating
+ * *buf and *n as necessary.
+ *
+ * In either case, on a successful call, *buf and *n will be updated to reflect
+ * the buffer address and allocated size respectively.
+ */
+ssize_t xbt_getline(char **buf, size_t *n, FILE *stream)
+{
+ ssize_t i;
+ int ch;
+
+ ch = getc(stream);
+ if (ferror(stream) || feof(stream))
+ return -1;
+
+ if (!*buf) {
+ *n = 512;
+ *buf = xbt_malloc(*n);
+ }
+
+ i = 0;
+ do {
+ if (i == *n)
+ *buf = xbt_realloc(*buf, *n += 512);
+ (*buf)[i++] = ch;
+ } while (ch != '\n' && (ch = getc(stream)) != EOF);
+
+ if (i == *n)
+ *buf = xbt_realloc(*buf, *n += 1);
+ (*buf)[i] = '\0';
+
+ return i;
+}
+
+/** @brief Returns the directory component of a path (reimplementation of POSIX dirname)
+ *
+ * The argument is never modified, and the returned value must be freed after use.
+ */
+char *xbt_dirname(const char *path) {
+#if _MSC_VER
+ char drive[_MAX_DRIVE];
+ char dir[_MAX_DIR];
+ errno_t err;
+ err = _splitpath_s(path, drive, _MAX_DRIVE, dir, _MAX_DIR, NULL,0, NULL,0);
+ return bprintf("%s%s",drive,dir);
+#else
+ return dirname(xbt_strdup(path));
+#endif
+}
#include "xbt/sysdep.h"
#include "xbt/log.h"
#include "xbt/str.h"
+#include "xbt/file.h"
#include "xbt/replay.h"
#include <ctype.h>
#include <wchar.h>
return res;
}
-/** @brief Get a single line from the stream (reimplementation of the GNU getline)
- *
- * This is a reimplementation of the GNU getline function, so that our code don't depends on the GNU libc.
- *
- * xbt_getline() reads an entire line from stream, storing the address of the
- * buffer containing the text into *buf. The buffer is null-terminated and
- * includes the newline character, if one was found.
- *
- * If *buf is NULL, then xbt_getline() will allocate a buffer for storing the
- * line, which should be freed by the user program.
- *
- * Alternatively, before calling xbt_getline(), *buf can contain a pointer to a
- * malloc()-allocated buffer *n bytes in size. If the buffer is not large
- * enough to hold the line, xbt_getline() resizes it with realloc(), updating
- * *buf and *n as necessary.
- *
- * In either case, on a successful call, *buf and *n will be updated to reflect
- * the buffer address and allocated size respectively.
- */
-ssize_t xbt_getline(char **buf, size_t *n, FILE *stream)
-{
- ssize_t i;
- int ch;
-
- ch = getc(stream);
- if (ferror(stream) || feof(stream))
- return -1;
-
- if (!*buf) {
- *n = 512;
- *buf = xbt_malloc(*n);
- }
-
- i = 0;
- do {
- if (i == *n)
- *buf = xbt_realloc(*buf, *n += 512);
- (*buf)[i++] = ch;
- } while (ch != '\n' && (ch = getc(stream)) != EOF);
-
- if (i == *n)
- *buf = xbt_realloc(*buf, *n += 1);
- (*buf)[i] = '\0';
-
- return i;
-}
-
/*
* Diff related functions
*
src/xbt/xbt_main.c
src/xbt/xbt_matrix.c
src/xbt/xbt_os_time.c
+ src/xbt/xbt_os_file.c
src/xbt/xbt_peer.c
src/xbt/xbt_queue.c
src/xbt/xbt_replay.c
include/xbt/dynar.h
include/xbt/ex.h
include/xbt/fifo.h
+ include/xbt/file.h
include/xbt/function_types.h
include/xbt/graph.h
include/xbt/graphxml.h
