Do case insensitive search for lua scripts to load.
[obnox/wireshark/wip.git] / wsutil / file_util.h
1 /* file_util.h
2  * File utility definitions
3  *
4  * $Id$
5  *
6  * Wireshark - Network traffic analyzer
7  * By Gerald Combs <gerald@wireshark.org>
8  * Copyright 1998 Gerald Combs
9  *
10  * This program is free software; you can redistribute it and/or
11  * modify it under the terms of the GNU General Public License
12  * as published by the Free Software Foundation; either version 2
13  * of the License, or (at your option) any later version.
14  *
15  * This program is distributed in the hope that it will be useful,
16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18  * GNU General Public License for more details.
19  *
20  * You should have received a copy of the GNU General Public License
21  * along with this program; if not, write to the Free Software
22  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
23  */
24
25 #ifndef __FILE_UTIL_H__
26 #define __FILE_UTIL_H__
27
28 #ifdef __cplusplus
29 extern "C" {
30 #endif /* __cplusplus */
31
32 #include <glib.h>
33
34 #ifdef _WIN32
35 #include <io.h>
36 #include <gmodule.h>
37 #endif
38
39 #ifdef HAVE_SYS_STAT_H
40 #include <sys/stat.h>
41 #endif
42
43
44 #ifdef _WIN32
45
46 /*
47  * The structure to pass to ws_stat64() and ws_fstat64().
48  */
49 #define ws_statb64      struct _stat64
50
51 /*  Win32: Since GLib2.6, we use UTF8 throughout the code, so file functions
52  *  must tweak a given filename from UTF8 to UTF16 as we use NT Unicode (Win9x
53  *  - now unsupported - used locale based encoding here).
54  */
55
56 #include <stdio.h>
57
58 extern int ws_stdio_open (const gchar *filename, int flags, int mode);
59 extern int ws_stdio_rename (const gchar *oldfilename, const gchar *newfilename);
60 extern int ws_stdio_mkdir (const gchar *filename, int mode);
61 extern int ws_stdio_stat64 (const gchar *filename, ws_statb64 *buf);
62 extern int ws_stdio_unlink (const gchar *filename);
63 extern int ws_stdio_remove (const gchar *filename);
64
65 extern FILE * ws_stdio_fopen (const gchar *filename, const gchar *mode);
66 extern FILE * ws_stdio_freopen (const gchar *filename, const gchar *mode, FILE *stream);
67
68 #define ws_open         ws_stdio_open
69 #define ws_rename       ws_stdio_rename
70 #define ws_mkdir        ws_stdio_mkdir
71 #define ws_stat64       ws_stdio_stat64
72 #define ws_unlink       ws_stdio_unlink
73 #define ws_remove       ws_stdio_remove
74 #define ws_fopen        ws_stdio_fopen
75 #define ws_freopen      ws_stdio_freopen
76
77 /*
78  * These routines don't take pathnames, so they're the same regardless
79  * of what version of GLib we have.
80  */
81 #define ws_read    _read
82 #define ws_write   _write
83 #define ws_close   _close
84 #define ws_dup     _dup
85 #define ws_fstat64 _fstati64    /* use _fstati64 for 64-bit size support */
86 #define ws_lseek64 _lseeki64    /* use _lseeki64 for 64-bit offset support */
87
88 /* DLL loading */
89
90 /** Try to remove the current directory from the DLL search path.
91  * SetDllDirectory is tried, then SetCurrentDirectory(program_dir)
92  *
93  * @return TRUE if we were able to call SetDllDirectory, FALSE otherwise.
94  */
95 gboolean ws_init_dll_search_path();
96
97 /** Load a DLL using LoadLibrary.
98  * Only the system and program directories are searched.
99  *
100  * @param library_name The name of the DLL.
101  * @return A handle to the DLL if found, NULL on failure.
102  */
103
104 void *ws_load_library(gchar *library_name);
105 /** Load a DLL using g_module_open.
106  * Only the system and program directories are searched.
107  *
108  * @param module_name The name of the DLL.
109  * @param flags Flags to be passed to g_module_open.
110  * @return A handle to the DLL if found, NULL on failure.
111  */
112 GModule *ws_module_open(gchar *module_name, GModuleFlags flags);
113
114 /*
115  * utf8 version of getenv, needed to get win32 filename paths
116  */
117 extern char *getenv_utf8(const char *varname);
118
119 #else   /* _WIN32 */
120
121 /*
122  * The structure to pass to ws_fstat64().
123  */
124 #define ws_statb64      struct stat
125
126 /* Not Windows, presumed to be UN*X-compatible */
127 #define ws_open                 open
128 #define ws_rename               rename
129 #define ws_mkdir(dir,mode)      mkdir(dir,mode)
130 #define ws_stat64               stat
131 #define ws_unlink               unlink
132 #define ws_remove               remove
133 #define ws_fopen                fopen
134 #define ws_freopen              freopen
135
136 #define ws_read    read
137 #define ws_write   write
138 #define ws_close   close
139 #define ws_dup     dup
140 #define ws_fstat64 fstat        /* AC_SYS_LARGEFILE should make off_t 64-bit */
141 #define ws_lseek64 lseek        /* AC_SYS_LARGEFILE should make off_t 64-bit */
142 #define O_BINARY   0            /* Win32 needs the O_BINARY flag for open() */
143
144 #endif /* _WIN32 */
145
146 /* directory handling */
147 #define WS_DIR                          GDir
148 #define WS_DIRENT                       const char
149 #define ws_dir_open                     g_dir_open
150 #define ws_dir_read_name                g_dir_read_name
151 #define ws_dir_get_name(dirent) dirent
152 #define ws_dir_rewind                   g_dir_rewind
153 #define ws_dir_close                    g_dir_close
154
155 /* XXX - remove include "dirent.h" */
156 /* XXX - remove include "direct.h" */
157 /* XXX - remove include "sys/stat.h" */
158 /* XXX - update docs (e.g. README.developer) */
159
160 #ifdef __cplusplus
161 }
162 #endif /* __cplusplus */
163
164 #endif /* __FILE_UTIL_H__ */