include/usp10.h

   1 /*
   2  * Copyright (C) 2005 Steven Edwards
   3  * Copyright (C) 2005 Vijay Kiran Kamuju
   4  *
   5  * This library is free software; you can redistribute it and/or
   6  * modify it under the terms of the GNU Lesser General Public
   7  * License as published by the Free Software Foundation; either
   8  * version 2.1 of the License, or (at your option) any later version.
   9  *
  10  * This library is distributed in the hope that it will be useful,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13  * Lesser General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU Lesser General Public
  16  * License along with this library; if not, write to the Free Software
  17  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
  18  */
  19
  20 #ifndef __USP10_H
  21 #define __USP10_H
  22
  23 #include <windows.h>
  24 /* FIXME: #include <specstrings.h> */
  25
  26 #ifdef __cplusplus
  27 extern "C" {
  28 #endif
  29
  30 /** ScriptStringAnalyse */
  31 #define  SSA_PASSWORD         0x00000001
  32 #define  SSA_TAB              0x00000002
  33 #define  SSA_CLIP             0x00000004
  34 #define  SSA_FIT              0x00000008
  35 #define  SSA_DZWG             0x00000010
  36 #define  SSA_FALLBACK         0x00000020
  37 #define  SSA_BREAK            0x00000040
  38 #define  SSA_GLYPHS           0x00000080
  39 #define  SSA_RTL              0x00000100
  40 #define  SSA_GCP              0x00000200
  41 #define  SSA_HOTKEY           0x00000400
  42 #define  SSA_METAFILE         0x00000800
  43 #define  SSA_LINK             0x00001000
  44 #define  SSA_HIDEHOTKEY       0x00002000
  45 #define  SSA_HOTKEYONLY       0x00002400
  46 #define  SSA_FULLMEASURE      0x04000000
  47 #define  SSA_LPKANSIFALLBACK  0x08000000
  48 #define  SSA_PIDX             0x10000000
  49 #define  SSA_LAYOUTRTL        0x20000000
  50 #define  SSA_DONTGLYPH        0x40000000
  51 #define  SSA_NOKASHIDA        0x80000000
  52
  53 /** StringIsComplex */
  54 #define  SIC_COMPLEX     1
  55 #define  SIC_ASCIIDIGIT  2
  56 #define  SIC_NEUTRAL     4
  57
  58 /** ScriptGetCMap */
  59 #define SGCM_RTL  0x00000001
  60
  61 /** ScriptApplyDigitSubstitution */
  62 #define SCRIPT_DIGITSUBSTITUTE_CONTEXT      0
  63 #define SCRIPT_DIGITSUBSTITUTE_NONE         1
  64 #define SCRIPT_DIGITSUBSTITUTE_NATIONAL     2
  65 #define SCRIPT_DIGITSUBSTITUTE_TRADITIONAL  3
  66
  67 #define SCRIPT_UNDEFINED  0
  68
  69 #define USP_E_SCRIPT_NOT_IN_FONT MAKE_HRESULT(SEVERITY_ERROR,FACILITY_ITF,0x200)
  70
  71 typedef enum tag_SCRIPT_JUSTIFY {
  72   SCRIPT_JUSTIFY_NONE           = 0,
  73   SCRIPT_JUSTIFY_ARABIC_BLANK   = 1,
  74   SCRIPT_JUSTIFY_CHARACTER      = 2,
  75   SCRIPT_JUSTIFY_RESERVED1      = 3,
  76   SCRIPT_JUSTIFY_BLANK          = 4,
  77   SCRIPT_JUSTIFY_RESERVED2      = 5,
  78   SCRIPT_JUSTIFY_RESERVED3      = 6,
  79   SCRIPT_JUSTIFY_ARABIC_NORMAL  = 7,
  80   SCRIPT_JUSTIFY_ARABIC_KASHIDA = 8,
  81   SCRIPT_JUSTIFY_ARABIC_ALEF    = 9,
  82   SCRIPT_JUSTIFY_ARABIC_HA      = 10,
  83   SCRIPT_JUSTIFY_ARABIC_RA      = 11,
  84   SCRIPT_JUSTIFY_ARABIC_BA      = 12,
  85   SCRIPT_JUSTIFY_ARABIC_BARA    = 13,
  86   SCRIPT_JUSTIFY_ARABIC_SEEN    = 14,
  87   SCRIPT_JUSTIFY_ARABIC_SEEN_M  = 15,
  88 } SCRIPT_JUSTIFY;
  89
  90 typedef struct tag_SCRIPT_CONTROL {
  91   DWORD uDefaultLanguage        :16;
  92   DWORD fContextDigits          :1;
  93   DWORD fInvertPreBoundDir      :1;
  94   DWORD fInvertPostBoundDir     :1;
  95   DWORD fLinkStringBefore       :1;
  96   DWORD fLinkStringAfter        :1;
  97   DWORD fNeutralOverride        :1;
  98   DWORD fNumericOverride        :1;
  99   DWORD fLegacyBidiClass        :1;
 100   DWORD fMergeNeutralItems      :1;
 101   DWORD fReserved               :7;
 102 } SCRIPT_CONTROL;
 103
 104 typedef struct {
 105   DWORD langid                  :16;
 106   DWORD fNumeric                :1;
 107   DWORD fComplex                :1;
 108   DWORD fNeedsWordBreaking      :1;
 109   DWORD fNeedsCaretInfo         :1;
 110   DWORD bCharSet                :8;
 111   DWORD fControl                :1;
 112   DWORD fPrivateUseArea         :1;
 113   DWORD fNeedsCharacterJustify  :1;
 114   DWORD fInvalidGlyph           :1;
 115   DWORD fInvalidLogAttr         :1;
 116   DWORD fCDM                    :1;
 117   DWORD fAmbiguousCharSet       :1;
 118   DWORD fClusterSizeVaries      :1;
 119   DWORD fRejectInvalid          :1;
 120 } SCRIPT_PROPERTIES;
 121
 122 typedef struct tag_SCRIPT_STATE {
 123   WORD uBidiLevel               :5;
 124   WORD fOverrideDirection       :1;
 125   WORD fInhibitSymSwap          :1;
 126   WORD fCharShape               :1;
 127   WORD fDigitSubstitute         :1;
 128   WORD fInhibitLigate           :1;
 129   WORD fDisplayZWG              :1;
 130   WORD fArabicNumContext        :1;
 131   WORD fGcpClusters             :1;
 132   WORD fReserved                :1;
 133   WORD fEngineReserved          :2;
 134 } SCRIPT_STATE;
 135
 136 typedef struct tag_SCRIPT_ANALYSIS {
 137   WORD eScript                  :10;
 138   WORD fRTL                     :1;
 139   WORD fLayoutRTL               :1;
 140   WORD fLinkBefore              :1;
 141   WORD fLinkAfter               :1;
 142   WORD fLogicalOrder            :1;
 143   WORD fNoGlyphIndex            :1;
 144   SCRIPT_STATE  s;
 145 } SCRIPT_ANALYSIS;
 146
 147 typedef struct tag_SCRIPT_ITEM {
 148   int iCharPos;
 149   SCRIPT_ANALYSIS a;
 150 } SCRIPT_ITEM;
 151
 152 typedef struct tag_SCRIPT_DIGITSUBSTITUTE {
 153   DWORD NationalDigitLanguage           :16;
 154   DWORD TraditionalDigitLanguage        :16;
 155   DWORD DigitSubstitute                 :8;
 156   DWORD dwReserved;
 157 } SCRIPT_DIGITSUBSTITUTE;
 158
 159 typedef struct tag_SCRIPT_FONTPROPERTIES {
 160   int   cBytes;
 161   WORD wgBlank;
 162   WORD wgDefault;
 163   WORD wgInvalid;
 164   WORD wgKashida;
 165   int iKashidaWidth;
 166 } SCRIPT_FONTPROPERTIES;
 167
 168 typedef struct tag_SCRIPT_TABDEF {
 169   int cTabStops;
 170   int iScale;
 171   int *pTabStops;
 172   int iTabOrigin;
 173 } SCRIPT_TABDEF;
 174
 175 typedef struct tag_SCRIPT_VISATTR {
 176   WORD uJustification   :4;
 177   WORD fClusterStart    :1;
 178   WORD fDiacritic       :1;
 179   WORD fZeroWidth       :1;
 180   WORD fReserved        :1;
 181   WORD fShapeReserved   :8;
 182 } SCRIPT_VISATTR;
 183
 184 typedef struct tag_SCRIPT_LOGATTR {
 185   BYTE    fSoftBreak      :1;
 186   BYTE    fWhiteSpace     :1;
 187   BYTE    fCharStop       :1;
 188   BYTE    fWordStop       :1;
 189   BYTE    fInvalid        :1;
 190   BYTE    fReserved       :3;
 191 } SCRIPT_LOGATTR;
 192
 193 typedef void *SCRIPT_CACHE;
 194 typedef void *SCRIPT_STRING_ANALYSIS;
 195
 196 #ifndef LSDEFS_DEFINED
 197 typedef struct tagGOFFSET {
 198   LONG  du;
 199   LONG  dv;
 200 } GOFFSET;
 201 #endif
 202
 203 typedef ULONG OPENTYPE_TAG;
 204
 205 typedef struct tagOPENTYPE_FEATURE_RECORD
 206 {
 207     OPENTYPE_TAG tagFeature;
 208     LONG         lParameter;
 209 } OPENTYPE_FEATURE_RECORD;
 210
 211 typedef struct tagSCRIPT_GLYPHPROP
 212 {
 213     SCRIPT_VISATTR sva;
 214     WORD           reserved;
 215 } SCRIPT_GLYPHPROP;
 216
 217 typedef struct tagSCRIPT_CHARPROP
 218 {
 219     WORD fCanGlyphAlone  :1;
 220     WORD reserved        :15;
 221 } SCRIPT_CHARPROP;
 222
 223 typedef struct tagTEXTRANGE_PROPERTIES
 224 {
 225     OPENTYPE_FEATURE_RECORD *potfRecords;
 226     INT                     cotfRecords;
 227 } TEXTRANGE_PROPERTIES;
 228
 229 /* Function Declarations */
 230
 231 HRESULT WINAPI ScriptApplyDigitSubstitution(const SCRIPT_DIGITSUBSTITUTE* psds,
 232                                             SCRIPT_CONTROL* psc, SCRIPT_STATE* pss);
 233 HRESULT WINAPI ScriptApplyLogicalWidth(const int *piDx, int cChars, int cGlyphs, const WORD *pwLogClust,
 234                                        const SCRIPT_VISATTR *psva, const int *piAdvance,
 235                                        const SCRIPT_ANALYSIS *psa, ABC *pABC, int *piJustify);
 236 HRESULT WINAPI ScriptRecordDigitSubstitution(LCID Locale, SCRIPT_DIGITSUBSTITUTE *psds);
 237 HRESULT WINAPI ScriptItemize(const WCHAR *pwcInChars, int cInChars, int cMaxItems,
 238                              const SCRIPT_CONTROL *psControl, const SCRIPT_STATE *psState,
 239                              SCRIPT_ITEM *pItems, int *pcItems);
 240 HRESULT WINAPI ScriptGetCMap(HDC hdc, SCRIPT_CACHE *psc, const WCHAR *pwcInChars, int cChars,
 241                              DWORD dwFlags, WORD *pwOutGlyphs);
 242 HRESULT WINAPI ScriptGetFontProperties(HDC hdc, SCRIPT_CACHE *psc, SCRIPT_FONTPROPERTIES *sfp);
 243 HRESULT WINAPI ScriptGetGlyphABCWidth(HDC hdc, SCRIPT_CACHE *psc, WORD wGlyph, ABC *pABC);
 244 HRESULT WINAPI ScriptGetLogicalWidths(const SCRIPT_ANALYSIS *psa, int cChars, int cGlyphs,
 245                                       const int *piGlyphWidth, const WORD *pwLogClust,
 246                                       const SCRIPT_VISATTR *psva, int *piDx);
 247 HRESULT WINAPI ScriptGetProperties(const SCRIPT_PROPERTIES ***ppSp, int *piNumScripts);
 248 HRESULT WINAPI ScriptStringAnalyse(HDC hdc,
 249                                    const void *pString,
 250                                    int cString,
 251                                    int cGlyphs,
 252                                    int iCharset,
 253                                    DWORD dwFlags,
 254                                    int iReqWidth,
 255                                    SCRIPT_CONTROL *psControl,
 256                                    SCRIPT_STATE *psState,
 257                                    const int *piDx,
 258                                    SCRIPT_TABDEF *pTabdef,
 259                                    const BYTE *pbInClass,
 260                                    SCRIPT_STRING_ANALYSIS *pssa);
 261 HRESULT WINAPI ScriptStringValidate(SCRIPT_STRING_ANALYSIS ssa);
 262 HRESULT WINAPI ScriptStringFree(SCRIPT_STRING_ANALYSIS *pssa);
 263 HRESULT WINAPI ScriptFreeCache(SCRIPT_CACHE *psc);
 264 HRESULT WINAPI ScriptIsComplex(const WCHAR* pwcInChars, int cInChars, DWORD dwFlags);
 265 HRESULT WINAPI ScriptJustify(const SCRIPT_VISATTR *psva, const int *piAdvance, int cGlyphs,
 266                              int iDx, int iMinKashida, int *piJustify);
 267 HRESULT WINAPI ScriptLayout(int cRuns, const BYTE *pbLevel, int *piVisualToLogical, int *piLogicalToVisual);
 268 HRESULT WINAPI ScriptShape(HDC hdc, SCRIPT_CACHE *psc, const WCHAR *pwcChars, int cChars, int cMaxGlyphs,
 269                            SCRIPT_ANALYSIS *psa, WORD *pwOutGlyphs, WORD *pwLogClust, SCRIPT_VISATTR *psva, int *pcGlyphs);
 270 HRESULT WINAPI ScriptPlace(HDC hdc, SCRIPT_CACHE *psc, const WORD *pwGlyphs, int cGlyphs, const SCRIPT_VISATTR *psva,
 271                            SCRIPT_ANALYSIS *psa, int *piAdvance, GOFFSET *pGoffset, ABC *pABC );
 272 HRESULT WINAPI ScriptBreak(const WCHAR *pwcChars, int cChars, const SCRIPT_ANALYSIS *psa, SCRIPT_LOGATTR *psla);
 273 HRESULT WINAPI ScriptCacheGetHeight(HDC hdc, SCRIPT_CACHE *psc, LONG *tmHeight);
 274 HRESULT WINAPI ScriptCPtoX(int iCP, BOOL fTrailing, int cChars, int cGlyphs, const WORD *pwLogClust, const SCRIPT_VISATTR *psva,
 275                            const int *piAdvance, const SCRIPT_ANALYSIS *psa, int *piX);
 276 HRESULT WINAPI ScriptXtoCP(int iX, int cChars, int cGlyphs, const WORD *pwLogClust, const SCRIPT_VISATTR *psva,
 277                            const int *piAdvance, const SCRIPT_ANALYSIS *psa, int *piCP, int *piTrailing);
 278 HRESULT WINAPI ScriptStringCPtoX(SCRIPT_STRING_ANALYSIS ssa, int icp, BOOL fTrailing, int *pX);
 279 HRESULT WINAPI ScriptStringXtoCP(SCRIPT_STRING_ANALYSIS ssa, int iX, int *piCh , int *piTrailing);
 280 HRESULT WINAPI ScriptStringGetLogicalWidths(SCRIPT_STRING_ANALYSIS ssa, int *piDx);
 281 HRESULT WINAPI ScriptStringGetOrder(SCRIPT_STRING_ANALYSIS ssa, UINT *puOrder);
 282 HRESULT WINAPI ScriptStringOut(SCRIPT_STRING_ANALYSIS ssa, int iX, int iY, UINT uOptions, const RECT *prc,
 283                                int iMinSel, int iMaxSel, BOOL fDisabled);
 284 HRESULT WINAPI ScriptTextOut(const HDC hdc, SCRIPT_CACHE *psc, int x, int y, UINT fuOptions, const RECT *lprc,
 285                              const SCRIPT_ANALYSIS *psa, const WCHAR *pwcReserved, int iReserved, const WORD *pwGlyphs,
 286                              int cGlyphs, const int *piAdvance, const int *piJustify, const GOFFSET *pGoffset);
 287 const int* WINAPI ScriptString_pcOutChars(SCRIPT_STRING_ANALYSIS ssa);
 288 const SCRIPT_LOGATTR* WINAPI ScriptString_pLogAttr(SCRIPT_STRING_ANALYSIS ssa);
 289 const SIZE* WINAPI ScriptString_pSize(SCRIPT_STRING_ANALYSIS ssa);
 290
 291 #ifdef __cplusplus
 292 } /* extern "C" */
 293 #endif
 294
 295 #endif /* __USP10_H */