libjf API reference guide

jf_journal_file_tab.h

Go to the documentation of this file.

/*
 * Copyright 2005 Tiian
 * {In real life Tiian is Christian Ferrari}
 * This file is part of "libjf" package.
 *
 * "libjf" is free software; you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as published by
 * the Free Software Foundation; either version 2.1 of the License, or
 * (at your option) any later version.
 *
 * "libjf" is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * GNU Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with ; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 */
#ifndef JF_JOURNAL_FILE_TAB_H
#define JF_JOURNAL_FILE_TAB_H



#include <jf/jf_config.h>



#include <jf/jf_journal_file.h>
#include <jf/jf_errors.h>
#include <jf/jf_trace.h>



/* save old JF_TRACE_MODULE and set a new value */
#ifdef JF_TRACE_MODULE
# define JF_TRACE_MODULE_SAVE JF_TRACE_MODULE
# undef JF_TRACE_MODULE
#else
# undef JF_TRACE_MODULE_SAVE
#endif /* JF_TRACE_MODULE */
#define JF_TRACE_MODULE      JF_TRACE_MOD_LIB_JOURNAL_FILE_TAB



#define JF_JOURNAL_FILE_TAB_SIZE             0x1

#define JF_JOURNAL_FILE_TAB_PATH             0x2

#define JF_JOURNAL_FILE_TAB_CTRL             0x4

#define JF_JOURNAL_GLOBAL_FILE_ID            0x0



#ifdef __cplusplus
extern "C" {
#endif /* __cplusplus */



        typedef struct {
                jf_word_t                 max_files;
                jf_word_t                 number_of_files;
                jf_journal_file_t        *files;
        } jf_journal_file_tab_t;




        static inline jf_word_t jf_journal_file_tab_get_number_of_files(
                const jf_journal_file_tab_t *jft) {
                return jft->number_of_files; }


      
        static inline jf_word_t jf_journal_file_tab_get_max_files(
                const jf_journal_file_tab_t *jft) {
                return jft->max_files; }



        static inline int jf_journal_file_tab_is_void(
                const jf_journal_file_tab_t *jft) {
                return (jft->number_of_files == 0 &&
                        jft->max_files == 0 && jft->files == NULL); }



        static inline jf_journal_file_t *jf_journal_file_tab_get_jfile(
                const jf_journal_file_tab_t *jft, jf_word_t pos) {
                if (pos >= jft->number_of_files) {
                        JF_TRACE(("jf_journal_file_tab_get_jfile"
                                  "/ret_cod=%d\n", JF_RC_OUT_OF_RANGE));
                        return NULL;
                }
                return &(jft->files[pos]);
        }


      
        void jf_journal_file_tab_create(jf_journal_file_tab_t *jft);



        void jf_journal_file_tab_destroy(jf_journal_file_tab_t *jft);



        int jf_journal_file_tab_init(jf_journal_file_tab_t *jft,
                                     jf_word_t max_files);



        int jf_journal_file_tab_add(jf_journal_file_tab_t *jft,
                                    const jf_journal_file_t *jf,
                                    jf_word_t *id);
      


        int jf_journal_file_tab_del(jf_journal_file_tab_t *jft, jf_word_t id);
        

        
        int jf_journal_file_tab_dump(const jf_journal_file_tab_t *jft,
                                     FILE *stream,
                                     jf_word_t flags, jf_word_t id);

      

        int jf_journal_file_tab_restore(jf_journal_file_tab_t *jft,
                                        FILE *stream);



        int jf_journal_file_tab_search(const jf_journal_file_tab_t *jft,
                                       const char *path, jf_word_t *pos);


      
        int jf_journal_file_tab_trace(const jf_journal_file_tab_t *jft,
                                      const char *method, FILE *out_stream);



#ifdef _DEBUG
# define JF_JOURNAL_FILE_TAB_TRACE(j, m, s) \
                    ((JF_TRACE_MODULE & \
                     (getenv(JF_TRACE_MASK_ENV_VAR) != NULL ? \
                      strtoul(getenv(JF_TRACE_MASK_ENV_VAR), NULL, 0) : \
                       0x0)) ? jf_journal_file_tab_trace(j, m, s) : 0)
#else
# define JF_JOURNAL_FILE_TAB_TRACE(j, m, s)
#endif /* _DEBUG */



#ifdef __cplusplus
}
#endif /* __cplusplus */



/* restore old value of JF_TRACE_MODULE */
#ifdef JF_TRACE_MODULE_SAVE
# undef JF_TRACE_MODULE
# define JF_TRACE_MODULE JF_TRACE_MODULE_SAVE
# undef JF_TRACE_MODULE_SAVE
#endif /* JF_TRACE_MODULE_SAVE */



#endif /* JF_JOURNAL_FILE_TAB_H */

---

Copyright 2005 © Tiian