lineBasedFile.h

Go to the documentation of this file.

// -*- Mode: C++; tab-width: 2; -*-
// vi: set ts=2:
//

#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:


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

    void clear();



    bool operator == (const LineBasedFile& f);

    bool operator != (const LineBasedFile& f);

      
    const LineBasedFile& operator = (const LineBasedFile& file);



    Position getLineNumber() const;

    const String& getLine() const;

    String& getLine();



    bool readLine();

    bool skipLines(Size number = 1);

    bool search(const String& text, bool return_to_start = false);

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

    bool gotoLine(Position line_number);

    void rewind();

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

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

    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_;

    vector<char> col_buffer_;

    //_@}
  };


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

#endif // BALL_FORMAT_LINEBASEDFILE_H