tools/tesh2/include/fstreams.h

   1 /*\r
   2  * include/fstreams.h - type representing a vector of file streams.\r
   3  *\r
   4  * Copyright 2008,2009 Martin Quinson, Malek Cherier All right reserved. \r
   5  *\r
   6  * This program is free software; you can redistribute it and/or modify it \r
   7  * under the terms of the license (GNU LGPL) which comes with this package.\r
   8  *\r
   9  * Purpose:\r
  10  *              This file contains all the declarations of the functions related with\r
  11  *              the tesh fstreams type.\r
  12  *\r
  13  */  \r
  14 #ifndef __FSTREAMS_H\r
  15 #define __FSTREAMS_H\r
  16     \r
  17 #include <com.h>\r
  18     \r
  19 #ifdef __cplusplus\r
  20 extern "C" {
  21   \r
  22 #endif  /* \r */
  23   \r
  24 /*! \brief fstreams_new - create a new fstreams.\r
  25  *\r
  26  * \param directory     The directory of the tesh file.\r
  27  * \param name          The name of the tesh file.\r
  28  *\r
  29  * \return                      If successful the function returns the newly created\r
  30  *                                      unit. Otherwise the function returns NULL and sets the\r
  31  *                                      global variable errno with the appropiate error code.\r
  32  * remarks:\r
  33  *                                      If the parameter directory is NULL, the parameter name\r
  34  *                                      must be `stdin`.\r
  35  *\r
  36  * errors :\r
  37  *                                      [EINVAL] if one of the parameters is invalid.\r
  38  *                                      [ENOMEM] if the system has not enough space to allocate\r
  39  *                                               the file stream.\r
  40  */ \r
  41   fstreams_t \r fstreams_new(void_f_pvoid_t fn_finalize);
  42   \r \r int \r fstreams_exclude(fstreams_t fstreams, excludes_t excludes);
  43   \r \r int \r fstreams_contains(fstreams_t fstreams, fstream_t fstream);
  44   \r \r int \r fstreams_add(fstreams_t fstreams, fstream_t fstream);
  45   \r \r int \r fstreams_free(void **fstreamsptr);
  46   \r\rint \r fstreams_get_size(fstreams_t fstreams);
  47   \r \r int \r fstreams_is_empty(fstreams_t fstreams);
  48   \r \r int \r fstreams_contains(fstreams_t fstreams, fstream_t fstream);
  49   \r \r int \r fstreams_load(fstreams_t fstreams);
  50   \r \r \r \r
  51 #ifdef __cplusplus\r
  52 } \r
  53 #endif  /* \r */
  54 \r \r
  55 #endif  /* !__FSTREAMS_H */\r