journal.h

/* ScummVM - Graphic Adventure Engine
 *
 * ScummVM is the legal property of its developers, whose names
 * are too numerous to list here. Please refer to the COPYRIGHT
 * file distributed with this source distribution.
 *
 * This program 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.
 *
 * This program 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 this program.  If not, see <http://www.gnu.org/licenses/>.
 *
 */

#ifndef SHERLOCK_JOURNAL_H
#define SHERLOCK_JOURNAL_H

#include "common/scummsys.h"
#include "common/array.h"
#include "common/rect.h"
#include "common/str-array.h"
#include "common/stream.h"
#include "sherlock/saveload.h"

namespace Sherlock {

#define LINES_PER_PAGE (IS_SERRATED_SCALPEL ? 11 : 17)
#define JOURNAL_MAX_WIDTH (IS_SERRATED_SCALPEL ? 230 : 422)
#define JOURNAL_MAX_CHARS 80

class SherlockEngine;

struct JournalEntry {
    int _converseNum;
    bool _replyOnly;
    int _statementNum;

    JournalEntry() : _converseNum(0), _replyOnly(false), _statementNum(0) {}
    JournalEntry(int converseNum, int statementNum, bool replyOnly = false) :
        _converseNum(converseNum), _statementNum(statementNum), _replyOnly(replyOnly) {}
};

class Journal {
protected:
    SherlockEngine *_vm;
    Common::StringArray _directory;
    Common::StringArray _locations;
    Common::Array<JournalEntry> _journal;
    Common::StringArray _lines;
    bool _up, _down;
    int _index;
    int _page;
    int _maxPage;
    int _sub;
    Common::String _find;

    Journal(SherlockEngine *vm);

    void loadJournalFile(bool alreadyLoaded);

    bool isPrintable(byte ch) const;
public:
    static Journal *init(SherlockEngine *vm);
    virtual ~Journal() {}

    bool drawJournal(int direction, int howFar);

    void synchronize(Serializer &s);
public:
    virtual void drawFrame() = 0;

    virtual void resetPosition() {}

    virtual void record(int converseNum, int statementNum, bool replyOnly = false);
};

} // End of namespace Sherlock

#endif