streamtokenizer.h

Go to the documentation of this file.

/* xoreos - A reimplementation of BioWare's Aurora engine
 *
 * xoreos is the legal property of its developers, whose names
 * can be found in the AUTHORS file distributed with this source
 * distribution.
 *
 * xoreos is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * as published by the Free Software Foundation; either version 3
 * of the License, or (at your option) any later version.
 *
 * xoreos is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with xoreos. If not, see <http://www.gnu.org/licenses/>.
 */

#ifndef COMMON_STREAMTOKENIZER_H
#define COMMON_STREAMTOKENIZER_H

#include <list>
#include <vector>

#include "src/common/types.h"
#include "src/common/ustring.h"

namespace Common {

class SeekableReadStream;

class StreamTokenizer {
public:
    enum ConsecutiveSeparatorRule {
        kRuleIgnoreSame, 
        kRuleIgnoreAll,  
        kRuleHeed        
    };

    StreamTokenizer(ConsecutiveSeparatorRule conSepRule = kRuleHeed);

    void addSeparator(uint32 c);

    void addChunkEnd (uint32 c);

    void addQuote    (uint32 c);

    void addIgnore   (uint32 c);

    UString getToken(SeekableReadStream &stream);

    size_t getTokens(SeekableReadStream &stream, std::vector<UString> &list,
            size_t min = 0, size_t max = SIZE_MAX, const UString &def = "");

    void findFirstToken(SeekableReadStream &stream);

    void skipToken(SeekableReadStream &stream, size_t n = 1);

    void skipChunk(SeekableReadStream &stream);

    void nextChunk(SeekableReadStream &stream);

private:
    ConsecutiveSeparatorRule _conSepRule;

    std::list<uint32> _separators;
    std::list<uint32> _quotes;
    std::list<uint32> _chunkEnds;
    std::list<uint32> _ignores;

    static bool isIn(uint32 c, const std::list<uint32> &list);

    bool isChunkEnd(SeekableReadStream &stream);
};

} // End of namespace Common

#endif // COMMON_STREAMTOKENIZER_H