lineBasedFile.h

Go to the documentation of this file.

// -*- Mode: C++; tab-width: 2; -*-
// vi: set ts=2:
//
// $Id: lineBasedFile.h,v 1.32.20.1 2007/03/28 08:23:44 bertsch Exp $
//

#ifndef BALL_FORMAT_LINEBASEDFILE_H
#define BALL_FORMAT_LINEBASEDFILE_H

#ifndef BALL_SYSTEM_FILE_H
# include <BALL/SYSTEM/file.h>
#endif

#include <vector>

namespace BALL 
{
  class BALL_EXPORT LineBasedFile
    : public File
  {
    public:

    BALL_CREATE(LineBasedFile)

    

    LineBasedFile()
      ;
      
    LineBasedFile(const String& filename, File::OpenMode open_mode = std::ios::in, bool trim_whitespaces = false)
      throw(Exception::FileNotFound);

    LineBasedFile(const LineBasedFile& f)
      throw(Exception::FileNotFound);

    void clear() 
      ;



    bool operator == (const LineBasedFile& f)  ;

    bool operator != (const LineBasedFile& f)  ;

      
    const LineBasedFile& operator = (const LineBasedFile& file)
      throw(Exception::FileNotFound);



    Position getLineNumber() 
      const ;

    const String& getLine() 
      const ;

    String& getLine() 
      ;



    bool readLine()
      throw(Exception::ParseError);

    bool skipLines(Size number = 1)
      throw(Exception::ParseError);

    bool search(const String& text, bool return_to_start = false)
      throw(Exception::ParseError);

    /* Search for a line starting with a given string, abort at a stop tag.
    */
    bool search(const String& text, const String& stop, bool return_to_start = false)
      throw(Exception::ParseError);

    bool gotoLine(Position line_number)
      throw(Exception::ParseError);

    void rewind()
      throw(Exception::ParseError);

    void test(const char* file, int line, bool condition, const String& msg) 
      const throw(Exception::ParseError);

    String getField(Index pos = 0, const String& quotes = "",
                    const String& delimiters = String::CHARACTER_CLASS__WHITESPACE)
      const throw(Exception::IndexUnderflow);

    bool startsWith(const String& text) 
      const ;

    bool has(const String& text) 
      const ;

    Index switchString(const std::vector<String>& data) 
      const ;

    bool parseColumnFormat(const char* format, Position index, Size length, void* arg);

    void enableTrimWhitespaces(bool state)
      ;
    
    bool trimWhiteSpacesEnabled() const
      ;

    protected:
    /*  @name Protected Attributes
    */
    //_@{
    String line_;

    Position line_number_;

    bool trim_whitespaces_;
    //_@}
  };


# ifndef BALL_NO_INLINE_FUNCTIONS
#   include <BALL/FORMAT/lineBasedFile.iC>
# endif
} // namespace BALL

#endif // BALL_FORMAT_LINEBASEDFILE_H