src/IO/DataFile.hpp

   1 /*
   2 Copyright_License {
   3
   4   XCSoar Glide Computer - http://www.xcsoar.org/
   5   Copyright (C) 2000-2013 The XCSoar Project
   6   A detailed list of copyright holders can be found in the file "AUTHORS".
   7
   8   This program is free software; you can redistribute it and/or
   9   modify it under the terms of the GNU General Public License
  10   as published by the Free Software Foundation; either version 2
  11   of the License, or (at your option) any later version.
  12
  13   This program is distributed in the hope that it will be useful,
  14   but WITHOUT ANY WARRANTY; without even the implied warranty of
  15   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16   GNU General Public License for more details.
  17
  18   You should have received a copy of the GNU General Public License
  19   along with this program; if not, write to the Free Software
  20   Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
  21 }
  22 */
  23
  24 #ifndef XCSOAR_IO_DATA_FILE_HPP
  25 #define XCSOAR_IO_DATA_FILE_HPP
  26
  27 #include "Source.hpp"
  28 #include "ConvertLineReader.hpp"
  29
  30 class TextWriter;
  31
  32 /**
  33  * Opens a file from the data directory.
  34  *
  35  * @param name the file name relative to the data directory
  36  * @return a Source which must be deleted by the caller; NULL if an
  37  * error occurred opening the file
  38  */
  39 Source<char> *
  40 OpenDataFile(const TCHAR *name);
  41
  42 /**
  43  * Opens a text file from the data directory.
  44  *
  45  * @param name the file name relative to the data directory
  46  * @param cs the character set of the input file
  47  * @return a TLineReader which must be deleted by the caller; NULL if
  48  * an error occurred opening the file
  49  */
  50 TLineReader *
  51 OpenDataTextFile(const TCHAR *name,
  52                  ConvertLineReader::charset cs=ConvertLineReader::UTF8);
  53
  54 /**
  55  * Opens a text file from the data directory.
  56  *
  57  * @param name the file name relative to the data directory
  58  * @return a TLineReader which must be deleted by the caller; NULL if
  59  * an error occurred opening the file
  60  */
  61 NLineReader *
  62 OpenDataTextFileA(const TCHAR *name);
  63
  64 /**
  65  * Creates a text file in the data directory.  If the file already
  66  * exists, it is truncated, unless "append" is true.
  67  */
  68 TextWriter *
  69 CreateDataTextFile(const TCHAR *name, bool append=false);
  70
  71 #endif