/usr/include/CEGUI/CEGUIBiDiVisualMapping.h is in libcegui-mk2-dev 0.7.6-3.3.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 | /***********************************************************************
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 "CEGUIString.h"
#include <vector>
#if defined (_MSC_VER)
# pragma warning(push)
# pragma warning(disable : 4251)
#endif
// Start of CEGUI namespace section
namespace CEGUI
{
//! Enumeration of possible character classes, used for bi-directional text.
enum BidiCharType
{
BCT_RIGHT_TO_LEFT,
BCT_LEFT_TO_RIGHT,
BCT_NEUTRAL
};
//! Abstract class to wrap a BiDi visual mapping of a text string.
class CEGUIEXPORT BiDiVisualMapping
{
public:
//! type definition for collection used to hold mapping index lists.
typedef std::vector<int> StrIndexList;
//! Destructor.
virtual ~BiDiVisualMapping();
/*!
\brief
Gets the BiDi char type of a char.
\param charToCheck
The utf32 character code that will be checked.
\return
One of the BidiCharType enumerated values indicating the BiDi char type.
*/
virtual BidiCharType getBidiCharType(const utf32 char_to_check) const = 0;
/*!
\brief
Reorder a string from a logical (type order) bidi string to a
visual (the way it displayed) string.
\param logical
String object to be reordered.
\param visual
String object containing the result reordered string.
\param l2vMapping
List of integers that map the pos of each char from logical string in
the visual string.
\param v2lMapping
List of integers that map the pos of each char from visual string in
the logical string.
\return
- true if successful.
- false if the operation failed.
*/
virtual bool reorderFromLogicalToVisual(const String& logical,
String& visual,
StrIndexList& l2v,
StrIndexList& v2l) const = 0;
/*!
\brief
Use reorderFromLogicalToVisual to update the internal visual mapping
data and visual string representation based upon the logical string
\a logical.
\param logical
String object representing the logical text order.
\return
- true if the update was a success.
- false if something went wrong.
*/
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_
|