Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

source: orxonox.OLD/trunk/src/lib/util/file.cc @ 8303

Last change on this file since 8303 was 8293, checked in by bensch, 19 years ago

orxonox/trunk: merged the osX-branche back here
merged with command:
svn merge https://svn.orxonox.net/orxonox/branches/osx . -r7763:HEAD

conflicts resolved, and everything is working as expected (or at least i hope so :) )

File size: 7.3 KB
Line 
1/*
2   orxonox - the future of 3D-vertical-scrollers
3
4   Copyright (C) 2004 orx
5
6   This program is free software; you can redistribute it and/or modify
7   it under the terms of the GNU General Public License as published by
8   the Free Software Foundation; either version 2, or (at your option)
9   any later version.
10
11### File Specific:
12   main-programmer: Benjamin Grauer
13   co-programmer: ...
14*/
15
16#include "file.h"
17
18#include <sys/types.h>
19#include <sys/stat.h>
20#include <stdio.h>
21
22#include <iostream>
23#include <fstream>
24
25#ifdef __unix__
26#include <unistd.h>
27#elif __WIN32__ || _MS_DOS_
28#include <dir.h>
29#else
30//#include <direct.h>
31#endif
32
33#include <cassert>
34
35/**
36 * @brief default constructor.
37 */
38File::File()
39{
40  this->init();
41}
42
43/**
44 * @brief A File will be constructed and stated from a given FileName.
45 * @param fileName the FileName to load and stat.
46 */
47File::File(const std::string& fileName)
48{
49  this->init();
50  this->setFileName(fileName);
51}
52
53/**
54 * @brief A File will be constructed and stated from a given other File.
55 * @param file the File to get the Name from.
56 */
57File::File(const File& file)
58{
59  this->init();
60  this->setFileName(file.name());
61}
62
63File::~File()
64{
65  this->close();
66
67  if (this->_status)
68    delete this->_status;
69}
70
71
72/**
73 * @brief initializes the File
74 *
75 * Stats the File, looks if it exists and sets the hadle to 0
76 */
77void File::init()
78{
79  this->_handle = 0;
80  this->_status = NULL;
81}
82
83
84/**
85 * @brief sets a new File to apply to this File.
86 * @param fileName the Filename of the File to access.
87 */
88void File::setFileName(const std::string& fileName)
89{
90  this->close();
91  this->_name = fileName;
92  File::homeDirCheck(this->_name);
93  this->statFile();
94}
95
96/**
97 * @brief sets the file to the new File.
98 * @param fileName the FileName to set the File to.
99 * @returns this File.
100 */
101File& File::operator=(const std::string& fileName)
102{
103  this->setFileName(fileName);
104  return *this;
105}
106
107/**
108 * @brief sets the file to the new File.
109 * @param file the File to set the File to.
110 * @returns this File.
111 */
112File& File::operator=(const File& file)
113{
114  this->setFileName(file.name());
115  return *this;
116}
117
118/**
119 * @brief compares two files.
120 * @param fileName the File to compare against the stored one.
121 * @returns true if the filenames match.
122 */
123bool File::operator==(const std::string& fileName) const
124{
125  return (this->_name == fileName);
126}
127
128/**
129 * @brief compares two files.
130 * @param file the File to compare against the stored one.
131 * @returns true if the filenames match.
132 */
133bool File::operator==(const File& file) const
134{
135  return (this->_name == file.name());
136}
137
138
139/**
140 * @brief stats a File.
141 * Gathers information about the File, like permissions, and if it exists.
142 */
143void File::statFile()
144{
145  if (this->_status == NULL)
146    this->_status = new struct stat;
147  // Check the End of the FileName and chop away any \ and //
148  std::string name = this->_name;
149  while (name[name.size()-1] == '/' ||
150         name[name.size()-1] == '\\')
151    name.resize(name.size()-1);
152  if (stat(name.c_str(), this->_status))
153  {
154    delete this->_status;
155    this->_status = NULL;
156  }
157}
158
159bool File::open(OpenMode mode)
160{
161#warning implement
162  return false;
163}
164
165bool File::close()
166{
167#warning implement
168  return false;
169}
170
171bool File::exists() const
172{
173  return (this->_status != NULL);
174}
175
176/**
177 * @brief checks if the file is a Link (symlink/hardlink on UNIX)
178 * @returns true if the File is a Link, false otherwise (on windows always false)
179 */
180bool File::isLink() const
181{
182#ifndef __WIN32__
183  return (this->_status != NULL && this->_status->st_mode & (S_IFLNK));
184#else
185  return false;
186#endif
187}
188
189/**
190 * @brief checks if the File is a regular File
191 * @returns true if the File is a Regular file.
192 */
193bool File::isFile() const
194{
195  return (this->_status != NULL && this->_status->st_mode & (S_IFREG));
196}
197
198/**
199 * @brief Checks if the File is a Directory
200 * @returns true if it is a directory/symlink false otherwise
201 */
202bool File::isDirectory() const
203{
204  return (this->_status != NULL && this->_status->st_mode & (S_IFDIR));
205}
206
207
208/// FIXME NEXT THREE FUNCTIONS
209bool File::isReadeable() const
210{
211#ifndef __WIN32__
212  return (this->_status != NULL && this->_status->st_mode & (S_IRUSR));
213#else
214  return (this->_status != NULL);
215#endif
216}
217bool File::isWriteable() const
218{
219#ifndef __WIN32__
220  return (this->_status != NULL && this->_status->st_mode & (S_IWUSR));
221#else
222  return (this->_status != NULL);
223#endif
224}
225bool File::isExecutable() const
226{
227#ifndef __WIN32__
228  return (this->_status != NULL && this->_status->st_mode & (S_IXUSR));
229#else
230  return (this->_status != NULL);
231#endif
232}
233
234/**
235 * @brief copies the File to another File.
236 * @param destination the Destination File.
237 * @returns true on success, false otherwise.
238 */
239bool File::copy(const File& destination)
240{
241  if (*this == destination)
242  {
243    std::cout << "files are the Same '" << this->_name << "'\n";
244    return false;
245  }
246  char ch;
247  std::ifstream iFile(this->_name.c_str());
248  std::ofstream oFile(destination.name().c_str());
249  while (iFile.get(ch))
250  {
251    oFile.put(ch);
252  }
253  return true;
254}
255
256/**
257 * @brief renames the File (move)
258 * @param destination the Destination to move this file to.
259 * @returns true on success, false otherwise.
260 *
261 * if the File was opened, it will be closed throuh this function.
262 * The File will also be closed, if the File was not renamed.
263 */
264bool File::rename(const File& destination)
265{
266  this->close();
267
268  if (!std::rename(this->_name.c_str(), destination.name().c_str()))
269  {
270    this->_name = destination.name();
271    this->statFile();
272    return true;
273  }
274  return false;
275}
276
277/**
278 * @brief touches the File.
279 * @returns true if the file could have been touched. false otherwise.
280 *
281 * Touching a File means creating it.
282 */
283bool File::touch()
284{
285  FILE* stream;
286  if( (stream = fopen (this->_name.c_str(), "w")) == NULL)
287  {
288    std::cout << "could not touch '" << this->_name << "' for writing\n";
289    return false;
290  }
291  fclose(stream);
292
293  this->statFile();
294  return true;
295}
296
297/**
298 * @brief delete the File on the Disk
299 * @returns true on success, false otherwise.
300 */
301bool File::remove()
302{
303  if (!this->exists())
304    return false;
305
306  this->close();
307  unlink(this->_name.c_str());
308  delete this->_status;
309  this->_status = NULL;
310
311  return true;
312}
313
314/**
315 * @brief transforms a Relative path to an absolute one.
316 * @param fileName the Absolute Path.
317 */
318void File::relToAbs(std::string& relFileName)
319{
320  if (relFileName.empty())
321    return ;
322  if (relFileName[0] !=  '/')
323  {
324    if (relFileName[0] == '.' && relFileName[1] != '.')
325      relFileName.erase(0);
326    relFileName = File::cwd() + relFileName;
327  }
328}
329
330void File::absToRel(std::string& absFileName)
331{
332  if (absFileName.find(cwd()) == 0)
333    absFileName.replace(0, File::cwd().size(), ".");
334}
335
336
337std::string File::_cwd = "";
338
339/**
340 * @returns the Current Woring Directory
341 */
342const std::string& File::cwd()
343{
344  if (File::_cwd.empty())
345  {
346    char cwd[1024];
347    char* errorCode = getcwd(cwd, 1024);
348    if (errorCode == 0)
349      return File::_cwd;
350
351    File::_cwd = cwd;
352  }
353  return File::_cwd;
354}
355
356/**
357 * @brief check if fileName has the '~/` prepended.
358 * @returns the fileName in absolute coordinate.
359 */
360void File::homeDirCheck(std::string& fileName)
361{
362  if (fileName.size() < 2 || fileName[0] != '~' || fileName[1] != '/')
363    return;
364  std::string homeDir;
365#ifdef __WIN32__
366  homeDir = getenv("USERPROFILE");
367#else
368  homeDir = getenv("HOME");
369#endif
370  fileName = homeDir + fileName.substr(1);
371}
372
373
374#include "file.h"
375
376
Note: See TracBrowser for help on using the repository browser.