BidiVisualMapping.h

/***********************************************************************
    filename:   CEGUIBidiVisualMapping.h
    created:    Wed Aug 5 2009
    author:     Paul D Turner <paul@cegui.org.uk>
*************************************************************************/
/***************************************************************************
 *   Copyright (C) 2004 - 2009 Paul D Turner & The CEGUI Development Team
 *
 *   Permission is hereby granted, free of charge, to any person obtaining
 *   a copy of this software and associated documentation files (the
 *   "Software"), to deal in the Software without restriction, including
 *   without limitation the rights to use, copy, modify, merge, publish,
 *   distribute, sublicense, and/or sell copies of the Software, and to
 *   permit persons to whom the Software is furnished to do so, subject to
 *   the following conditions:
 *
 *   The above copyright notice and this permission notice shall be
 *   included in all copies or substantial portions of the Software.
 *
 *   THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
 *   EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
 *   MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
 *   IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR
 *   OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
 *   ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
 *   OTHER DEALINGS IN THE SOFTWARE.
 ***************************************************************************/
#ifndef _CEGUIBidiVisualMapping_h_
#define _CEGUIBidiVisualMapping_h_

#include "CEGUI/String.h"
#include <vector>

#if defined (_MSC_VER)
#   pragma warning(push)
#   pragma warning(disable : 4251)
#endif

// Start of CEGUI namespace section
namespace CEGUI
{
enum BidiCharType
{
    BCT_RIGHT_TO_LEFT,
    BCT_LEFT_TO_RIGHT,
    BCT_NEUTRAL
};

class CEGUIEXPORT BidiVisualMapping :
    public AllocatedObject<BidiVisualMapping>
{
public:
    typedef std::vector<int
        CEGUI_VECTOR_ALLOC(int)> StrIndexList;

    virtual ~BidiVisualMapping();

    virtual BidiCharType getBidiCharType(const String::value_type char_to_check) const = 0;


    virtual bool reorderFromLogicalToVisual(const String& logical,
                                            String& visual,
                                            StrIndexList& l2v,
                                            StrIndexList& v2l) const = 0;
    bool updateVisual(const String& logical);


    const StrIndexList getL2vMapping() const
        {return d_l2vMapping;}
    const StrIndexList getV2lMapping() const
        {return d_v2lMapping;}
    const String& getTextVisual() const
        {return d_textVisual;}

protected:
    StrIndexList d_l2vMapping;
    StrIndexList d_v2lMapping;
    String d_textVisual;
};

} // End of  CEGUI namespace section

#if defined (_MSC_VER)
#   pragma warning(pop)
#endif

#endif  // end of guard _CEGUIBidiVisualMapping_h_