/* vim:set et ts=4 sts=4:
 *
 * ibus-pinyin - The Chinese PinYin engine for IBus
 *
 * Copyright (c) 2008-2010 Peng Huang <shawn.p.huang@gmail.com>
 *
 * 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 2, 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, write to the Free Software
 * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
 */
#ifndef __PHONETIC_CONTEXT_H_
#define __PHONETIC_CONTEXT_H_

#include <string>
#include <vector>
#include "PyZyInputContext.h"
#include "PyZyConfig.h"
#include "PyZyPinyinArray.h"
#include "PyZyPhraseEditor.h"
#include "PyZySpecialPhraseTable.h"

namespace PyZy {

struct Preedit {
    std::string selected_text;
    std::string candidate_text;
    std::string rest_text;

    void clear () {
        selected_text.clear ();
        candidate_text.clear ();
        rest_text.clear ();
    }
};


class PhoneticContext : public InputContext {
public:
    PhoneticContext (Config & config, PhoneticContext::Observer *observer);
    virtual ~PhoneticContext (void);

    virtual bool processKeyEvent (unsigned short key_event);

    virtual void update (void);
    virtual void commit (void) = 0;
    virtual void reset (void);

    /* inline functions */
    virtual std::string selectedText (void) const { return m_preedit_text.selected_text; }
    virtual std::string conversionText (void) const { return m_preedit_text.candidate_text; }
    virtual std::string restText (void) const { return m_preedit_text.rest_text; }
    virtual std::string auxiliaryText (void) const { return m_auxiliary_text; }
    virtual std::vector<Candidate> candidates () const { return m_candidates; }
    virtual std::string inputText () const { return m_text; }
    unsigned int cursor () const { return m_cursor; }
    unsigned int focusedCandidate () const { return m_focused_candidate; }
    unsigned int page () const { return m_focused_candidate / m_config.pageSize (); }

protected:

    virtual void updateLookupTable (void);
    virtual gboolean updateSpecialPhrases (void);
    gboolean selectCandidate (guint i);
    gboolean selectCandidateInPage (guint i);
    gboolean resetCandidate (guint i);
    gboolean resetCandidateInPage (guint i);
    gboolean focusCandidate (guint i);
    gboolean focusCandidateInPage (guint i);

    virtual void selectPage (guint i);

    /* inline functions */
    void updatePhraseEditor (void)
    {
        m_phrase_editor.update (m_pinyin);
    }

    const gchar * textAfterPinyin () const
    {
        return (const gchar *)m_text + m_pinyin_len;
    }

    const gchar * textAfterPinyin (guint i) const
    {
        g_assert (i <= m_pinyin.size ());
        if ( G_UNLIKELY (i == 0))
            return m_text;
        i--;
        return (const gchar *)m_text + m_pinyin[i].begin + m_pinyin[i].len;
    }

    const gchar * textAfterCursor () const
    {
        return (const gchar *)m_text + m_cursor;
    }

    /* pure virtual functions */
    virtual gboolean insert (gint ch) = 0;
    virtual gboolean removeCharBefore (void) = 0;
    virtual gboolean removeCharAfter (void) = 0;
    virtual gboolean removeWordBefore (void) = 0;
    virtual gboolean removeWordAfter (void) = 0;
    virtual gboolean moveCursorLeft (void) = 0;
    virtual gboolean moveCursorRight (void) = 0;
    virtual gboolean moveCursorLeftByWord (void) = 0;
    virtual gboolean moveCursorRightByWord (void) = 0;
    virtual gboolean moveCursorToBegin (void) = 0;
    virtual gboolean moveCursorToEnd (void) = 0;
    virtual void updateAuxiliaryText (void) = 0;
    virtual void updatePreeditText (void) = 0;

    /* variables */
    Config                     &m_config;
    guint                       m_cursor;
    guint                       m_focused_candidate;
    PinyinArray                 m_pinyin;
    guint                       m_pinyin_len;
    String                      m_buffer;
    PhraseEditor                m_phrase_editor;
    std::vector<std::string>    m_special_phrases;
    std::string                 m_selected_special_phrase;
    String                      m_text;
    Preedit                     m_preedit_text;
    PhoneticContext::Observer     *m_observer;
    std::vector<Candidate>      m_candidates;
    std::string                 m_auxiliary_text;
};

}; // namespace PyZy

#endif  // __PHONETIC_CONTEXT_H_