/[osn-commons]/trunk/uar/uar.h
ViewVC logotype

Diff of /trunk/uar/uar.h

Parent Directory Parent Directory | Revision Log Revision Log | View Patch Patch

revision 23 by rakinar2, Mon Aug 5 17:15:48 2024 UTC revision 33 by rakinar2, Thu Aug 8 16:57:39 2024 UTC
# Line 2  Line 2 
2  #define UAR_UAR_H  #define UAR_UAR_H
3    
4  #include <stdbool.h>  #include <stdbool.h>
5    #include <stdint.h>
6    #include <sys/stat.h>
7  #include <sys/types.h>  #include <sys/types.h>
8    
9  struct uar_archive;  struct uar_archive;
# Line 17  enum uar_error Line 19  enum uar_error
19      UAR_INVALID_ARGUMENT,      UAR_INVALID_ARGUMENT,
20      UAR_INVALID_OPERATION,      UAR_INVALID_OPERATION,
21      UAR_INVALID_PATH,      UAR_INVALID_PATH,
22      UAR_SYSTEM_ERROR      UAR_SYSTEM_ERROR,
23        UAR_SYSCALL_ERROR,
24  };  };
25    
26    enum uar_file_type
27    {
28        UF_FILE,
29        UF_DIR,
30        UF_LINK
31    };
32    
33    enum uar_error_level
34    {
35        UAR_ELEVEL_NONE,
36        UAR_ELEVEL_ERROR,
37        UAR_ELEVEL_WARNING,
38    };
39    
40    typedef bool (*uar_callback_t) (struct uar_archive *uar, struct uar_file *file,
41                                    const char *uar_name, const char *fs_name);
42    
43    typedef bool (*uar_create_callback_t) (
44        struct uar_archive *uar, struct uar_file *file, const char *uar_name,
45        const char *fs_name, enum uar_error_level level, const char *message);
46    
47    void uar_set_create_callback (struct uar_archive *uar,
48                                  uar_create_callback_t callback);
49    
50    struct uar_archive *uar_create (void);
51  struct uar_archive *uar_open (const char *filename);  struct uar_archive *uar_open (const char *filename);
52  bool uar_has_error (const struct uar_archive *restrict uar);  struct uar_archive *uar_create_stream (void);
53  void uar_close (struct uar_archive *uar);  void uar_close (struct uar_archive *uar);
54    
55    struct uar_file *uar_stream_add_file (struct uar_archive *uar,
56                                          const char *uar_filename,
57                                          const char *fs_filename,
58                                          struct stat *stinfo);
59    bool uar_stream_write (struct uar_archive *uar, const char *filename);
60    
61    bool uar_has_error (const struct uar_archive *restrict uar);
62  const char *uar_strerror (const struct uar_archive *restrict uar);  const char *uar_strerror (const struct uar_archive *restrict uar);
63  struct uar_archive *uar_create ();  uint64_t uar_get_file_count (const struct uar_archive *restrict uar);
64    
65  struct uar_file *uar_add_file (struct uar_archive *restrict uar,  struct uar_file *uar_add_file (struct uar_archive *restrict uar,
66                                 const char *name, const char *path);                                 const char *name, const char *path,
67  void uar_file_set_mode (struct uar_file *file, mode_t mode);                                 struct stat *stinfo);
68  bool uar_write (struct uar_archive *uar, const char *filename);  struct uar_file *
69  struct uar_file *uar_add_dir (struct uar_archive *uar, const char *name,  uar_add_dir (struct uar_archive *uar, const char *name, const char *path,
70                                const char *path);               bool (*callback) (struct uar_file *file, const char *fullname,
71                                   const char *fullpath));
72  bool uar_extract (struct uar_archive *uar, const char *cwd,  bool uar_extract (struct uar_archive *uar, const char *cwd,
73                    bool (*callback) (struct uar_file *file));                    bool (*callback) (struct uar_file *file));
74  const char *uar_get_file_name (const struct uar_file *file);  bool uar_write (struct uar_archive *uar, const char *filename);
75    bool uar_iterate (struct uar_archive *uar,
76                      bool (*callback) (struct uar_file *file, void *data),
77                      void *data);
78    
79    struct uar_file *uar_file_create (const char *name, uint64_t namelen,
80                                      uint64_t size, uint32_t offset);
81    
82    bool uar_add_file_entry (struct uar_archive *restrict uar,
83                             struct uar_file *file);
84    
85    void uar_file_destroy (struct uar_file *file);
86    
87    struct uar_file *uar_stream_add_entry (struct uar_archive *uar,
88                                           const char *uar_name,
89                                           const char *fs_name,
90                                           struct stat *stinfo);
91    struct uar_file *uar_stream_add_dir (struct uar_archive *uar,
92                                         const char *uar_dirname,
93                                         const char *fs_dirname,
94                                         struct stat *stinfo);
95    
96    const char *uar_file_get_name (const struct uar_file *file);
97    enum uar_file_type uar_file_get_type (const struct uar_file *file);
98    uint64_t uar_file_get_size (const struct uar_file *file);
99    mode_t uar_file_get_mode (const struct uar_file *file);
100    void uar_file_set_mode (struct uar_file *file, mode_t mode);
101    uint64_t uar_file_get_namelen (const struct uar_file *file);
102    time_t uar_file_get_mtime (const struct uar_file *file);
103    const char *uar_get_error_file (const struct uar_archive *uar);
104    
105  #ifndef NDEBUG  #ifdef UAR_PRINT_VERBOSE_IMPL_INFO
106  void uar_debug_print (const struct uar_archive *uar, bool print_file_contents);  void uar_debug_print (const struct uar_archive *uar, bool print_file_contents);
107  #endif  #endif
108    
Legend:
Removed from v.23  
changed lines
  Added in v.33
[email protected]
 ViewVC Help
Powered by ViewVC 1.1.26