Edinburgh Speech Tools  2.1-release
EST_io_aux.h
Go to the documentation of this file.
1 /*************************************************************************/
2 /* */
3 /* Centre for Speech Technology Research */
4 /* University of Edinburgh, UK */
5 /* Copyright (c) 1994,1995,1996 */
6 /* All Rights Reserved. */
7 /* */
8 /* Permission is hereby granted, free of charge, to use and distribute */
9 /* this software and its documentation without restriction, including */
10 /* without limitation the rights to use, copy, modify, merge, publish, */
11 /* distribute, sublicense, and/or sell copies of this work, and to */
12 /* permit persons to whom this work is furnished to do so, subject to */
13 /* the following conditions: */
14 /* 1. The code must retain the above copyright notice, this list of */
15 /* conditions and the following disclaimer. */
16 /* 2. Any modifications must be clearly marked as such. */
17 /* 3. Original authors' names are not deleted. */
18 /* 4. The authors' names are not used to endorse or promote products */
19 /* derived from this software without specific prior written */
20 /* permission. */
21 /* */
22 /* THE UNIVERSITY OF EDINBURGH AND THE CONTRIBUTORS TO THIS WORK */
23 /* DISCLAIM ALL WARRANTIES WITH REGARD TO THIS SOFTWARE, INCLUDING */
24 /* ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO EVENT */
25 /* SHALL THE UNIVERSITY OF EDINBURGH NOR THE CONTRIBUTORS BE LIABLE */
26 /* FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES */
27 /* WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN */
28 /* AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, */
29 /* ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF */
30 /* THIS SOFTWARE. */
31 /* */
32 /*************************************************************************/
33 /* Author : Paul Taylor */
34 /* Date : February 1997 */
35 /*-----------------------------------------------------------------------*/
36 /* Utility IO Function header file */
37 /* */
38 /*=======================================================================*/
39 
40 #ifndef __EST_IO_AUX_H__
41 #define __EST_IO_AUX_H__
42 
43 #include "EST_unix.h"
44 #include "EST_common.h"
45 #include "EST_String.h"
46 #include "EST_types.h"
47 
48 /** \defgroup utilityfunctionsforio Utility IO Function header file
49  */
50 
51 
52 /** \file
53  * \brief Utility IO Function header file.
54  * \addtogroup utilityfunctionsforio
55  * @{
56  * \fn EST_String make_tmp_filename()
57  * \brief Make a unique temporary filename
58  * \fn EST_String stdin_to_file()
59  * \brief Copy stdin to a file and return the name of that tmpfile
60  * \fn int writable_file(char *filename)
61  * \brief return true if this file is writeable
62  * \fn int readable_file(char *filename)
63  * \brief return true if this file is readable
64  * \fn inline int delete_file(const EST_String &filename)
65  * \brief OS independent way of removing a file
66  * \fn EST_String uncompress_file_to_temporary(const EST_String &filename,const EST_String &prog_name)
67  * \brief Uncompress file by calling program prog, and write it to new tempoary file. Return name of temporary file
68  * \fn int compress_file_in_place(const EST_String &filename, const EST_String &prog_name)
69  * \brief Uncompress file and over-write existing file with uncompressed version
70  * \fn int compress_file(const EST_String &filename, const EST_String &new_filename, const EST_String &prog_name)
71  * \brief compress file by calling program prog, writing result to new_filename
72  * @}
73  */
74 
77 int writable_file(char *filename);
78 int readable_file(char *filename);
79 
80 inline int
81 delete_file(const EST_String &filename)
82 {
83  // a little unnecessary to wrap this up like this -- except
84  // if you want to be portable to weird OSs
85  return (unlink(filename) == 0);
86 
87  // could do more with return codes from unlink ...
88 }
89 
90 EST_String uncompress_file_to_temporary(const EST_String &filename,const EST_String &prog_name);
91 
92 int compress_file_in_place(const EST_String &filename, const EST_String &prog_name);
93 
94 int compress_file(const EST_String &filename,
95  const EST_String &new_filename,
96  const EST_String &prog_name);
97 
98 #define numeric_char(in) (((in < '9' ) && (in > '0')) ? TRUE : FALSE)
99 
100 #ifdef WIN32
101 #include "Winsock2.h"
102 typedef SOCKET SOCKET_FD;
103 #else
104 typedef int SOCKET_FD;
105 #endif
106 int socket_receive_file(SOCKET_FD fd, const EST_String &filename);
107 int socket_send_file(SOCKET_FD fd, const EST_String &filename);
108 
109 #endif /*__EST_IO_AUX_H__ */
int readable_file(char *filename)
return true if this file is readable
Definition: util_io.cc:65
int socket_receive_file(SOCKET_FD fd, const EST_String &filename)
Definition: filetrans.cc:74
int writable_file(char *filename)
return true if this file is writeable
Definition: util_io.cc:77
EST_String make_tmp_filename()
Make a unique temporary filename.
Definition: util_io.cc:56
int socket_send_file(SOCKET_FD fd, const EST_String &filename)
Definition: filetrans.cc:112
int compress_file_in_place(const EST_String &filename, const EST_String &prog_name)
Uncompress file and over-write existing file with uncompressed version.
Definition: util_io.cc:223
EST_String uncompress_file_to_temporary(const EST_String &filename, const EST_String &prog_name)
Uncompress file by calling program prog, and write it to new tempoary file. Return name of temporary ...
Definition: util_io.cc:205
EST_String stdin_to_file()
Copy stdin to a file and return the name of that tmpfile.
Definition: util_io.cc:96
int delete_file(const EST_String &filename)
OS independent way of removing a file.
Definition: EST_io_aux.h:81
int compress_file(const EST_String &filename, const EST_String &new_filename, const EST_String &prog_name)
compress file by calling program prog, writing result to new_filename
Definition: util_io.cc:229
int SOCKET_FD
Definition: EST_io_aux.h:104