Crazy Eddies GUI System 0.7.5
CEGUIBiDiVisualMapping.h
00001 /***********************************************************************
00002     filename:   CEGUIBiDiVisualMapping.h
00003     created:    Wed Aug 5 2009
00004     author:     Paul D Turner <paul@cegui.org.uk>
00005 *************************************************************************/
00006 /***************************************************************************
00007  *   Copyright (C) 2004 - 2009 Paul D Turner & The CEGUI Development Team
00008  *
00009  *   Permission is hereby granted, free of charge, to any person obtaining
00010  *   a copy of this software and associated documentation files (the
00011  *   "Software"), to deal in the Software without restriction, including
00012  *   without limitation the rights to use, copy, modify, merge, publish,
00013  *   distribute, sublicense, and/or sell copies of the Software, and to
00014  *   permit persons to whom the Software is furnished to do so, subject to
00015  *   the following conditions:
00016  *
00017  *   The above copyright notice and this permission notice shall be
00018  *   included in all copies or substantial portions of the Software.
00019  *
00020  *   THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
00021  *   EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
00022  *   MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
00023  *   IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR
00024  *   OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
00025  *   ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
00026  *   OTHER DEALINGS IN THE SOFTWARE.
00027  ***************************************************************************/
00028 #ifndef _CEGUIBiDiVisualMapping_h_
00029 #define _CEGUIBiDiVisualMapping_h_
00030 
00031 #include "CEGUIString.h"
00032 #include <vector>
00033 
00034 #if defined (_MSC_VER)
00035 #   pragma warning(push)
00036 #   pragma warning(disable : 4251)
00037 #endif
00038 
00039 // Start of CEGUI namespace section
00040 namespace CEGUI
00041 {
00043 enum BidiCharType
00044 {
00045     BCT_RIGHT_TO_LEFT,
00046     BCT_LEFT_TO_RIGHT,
00047     BCT_NEUTRAL
00048 };
00049 
00051 class CEGUIEXPORT BiDiVisualMapping
00052 {
00053 public:
00055     typedef std::vector<int> StrIndexList;
00056 
00058     virtual ~BiDiVisualMapping();
00059 
00070     virtual BidiCharType getBidiCharType(const utf32 char_to_check) const = 0;
00071 
00072 
00096     virtual bool reorderFromLogicalToVisual(const String& logical,
00097                                             String& visual,
00098                                             StrIndexList& l2v,
00099                                             StrIndexList& v2l) const = 0;
00113     bool updateVisual(const String& logical);
00114 
00115 
00116     const StrIndexList getL2vMapping() const
00117         {return d_l2vMapping;}
00118     const StrIndexList getV2lMapping() const
00119         {return d_v2lMapping;}
00120     const String& getTextVisual() const
00121         {return d_textVisual;}
00122 
00123 protected:
00124     StrIndexList d_l2vMapping;
00125     StrIndexList d_v2lMapping;
00126     String d_textVisual;
00127 };
00128 
00129 } // End of  CEGUI namespace section
00130 
00131 #if defined (_MSC_VER)
00132 #   pragma warning(pop)
00133 #endif
00134 
00135 #endif  // end of guard _CEGUIBiDiVisualMapping_h_