Layout.h revision 01f526614431e3a0a6e1a48039e00b8a9b7d6fbf
19cc9bbe1461f359f0b27c5e7645c17dda001ab1dRaph Levien/* 29cc9bbe1461f359f0b27c5e7645c17dda001ab1dRaph Levien * Copyright (C) 2013 The Android Open Source Project 39cc9bbe1461f359f0b27c5e7645c17dda001ab1dRaph Levien * 49cc9bbe1461f359f0b27c5e7645c17dda001ab1dRaph Levien * Licensed under the Apache License, Version 2.0 (the "License"); 59cc9bbe1461f359f0b27c5e7645c17dda001ab1dRaph Levien * you may not use this file except in compliance with the License. 69cc9bbe1461f359f0b27c5e7645c17dda001ab1dRaph Levien * You may obtain a copy of the License at 79cc9bbe1461f359f0b27c5e7645c17dda001ab1dRaph Levien * 89cc9bbe1461f359f0b27c5e7645c17dda001ab1dRaph Levien * http://www.apache.org/licenses/LICENSE-2.0 99cc9bbe1461f359f0b27c5e7645c17dda001ab1dRaph Levien * 109cc9bbe1461f359f0b27c5e7645c17dda001ab1dRaph Levien * Unless required by applicable law or agreed to in writing, software 119cc9bbe1461f359f0b27c5e7645c17dda001ab1dRaph Levien * distributed under the License is distributed on an "AS IS" BASIS, 129cc9bbe1461f359f0b27c5e7645c17dda001ab1dRaph Levien * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 139cc9bbe1461f359f0b27c5e7645c17dda001ab1dRaph Levien * See the License for the specific language governing permissions and 149cc9bbe1461f359f0b27c5e7645c17dda001ab1dRaph Levien * limitations under the License. 159cc9bbe1461f359f0b27c5e7645c17dda001ab1dRaph Levien */ 169cc9bbe1461f359f0b27c5e7645c17dda001ab1dRaph Levien 179cc9bbe1461f359f0b27c5e7645c17dda001ab1dRaph Levien#ifndef MINIKIN_LAYOUT_H 189cc9bbe1461f359f0b27c5e7645c17dda001ab1dRaph Levien#define MINIKIN_LAYOUT_H 199cc9bbe1461f359f0b27c5e7645c17dda001ab1dRaph Levien 209cc9bbe1461f359f0b27c5e7645c17dda001ab1dRaph Levien#include <hb.h> 219cc9bbe1461f359f0b27c5e7645c17dda001ab1dRaph Levien 229cc9bbe1461f359f0b27c5e7645c17dda001ab1dRaph Levien#include <vector> 239cc9bbe1461f359f0b27c5e7645c17dda001ab1dRaph Levien 249cc9bbe1461f359f0b27c5e7645c17dda001ab1dRaph Levien#include <minikin/FontCollection.h> 25bcc3dc5a2591a95a57e379e27cbad69c18e91e67Raph Levien#include <minikin/MinikinFontFreeType.h> 269cc9bbe1461f359f0b27c5e7645c17dda001ab1dRaph Levien 279cc9bbe1461f359f0b27c5e7645c17dda001ab1dRaph Leviennamespace android { 289cc9bbe1461f359f0b27c5e7645c17dda001ab1dRaph Levien 299cc9bbe1461f359f0b27c5e7645c17dda001ab1dRaph Levien// The Bitmap class is for debugging. We'll probably move it out 309cc9bbe1461f359f0b27c5e7645c17dda001ab1dRaph Levien// of here into a separate lightweight software rendering module 319cc9bbe1461f359f0b27c5e7645c17dda001ab1dRaph Levien// (optional, as we'd hope most clients would do their own) 329cc9bbe1461f359f0b27c5e7645c17dda001ab1dRaph Levienclass Bitmap { 339cc9bbe1461f359f0b27c5e7645c17dda001ab1dRaph Levienpublic: 349cc9bbe1461f359f0b27c5e7645c17dda001ab1dRaph Levien Bitmap(int width, int height); 359cc9bbe1461f359f0b27c5e7645c17dda001ab1dRaph Levien ~Bitmap(); 369cc9bbe1461f359f0b27c5e7645c17dda001ab1dRaph Levien void writePnm(std::ofstream& o) const; 37bcc3dc5a2591a95a57e379e27cbad69c18e91e67Raph Levien void drawGlyph(const GlyphBitmap& bitmap, int x, int y); 389cc9bbe1461f359f0b27c5e7645c17dda001ab1dRaph Levienprivate: 399cc9bbe1461f359f0b27c5e7645c17dda001ab1dRaph Levien int width; 409cc9bbe1461f359f0b27c5e7645c17dda001ab1dRaph Levien int height; 419cc9bbe1461f359f0b27c5e7645c17dda001ab1dRaph Levien uint8_t* buf; 429cc9bbe1461f359f0b27c5e7645c17dda001ab1dRaph Levien}; 439cc9bbe1461f359f0b27c5e7645c17dda001ab1dRaph Levien 449cc9bbe1461f359f0b27c5e7645c17dda001ab1dRaph Levienstruct LayoutGlyph { 459cc9bbe1461f359f0b27c5e7645c17dda001ab1dRaph Levien // index into mFaces and mHbFonts vectors. We could imagine 469cc9bbe1461f359f0b27c5e7645c17dda001ab1dRaph Levien // moving this into a run length representation, because it's 479cc9bbe1461f359f0b27c5e7645c17dda001ab1dRaph Levien // more efficient for long strings, and we'll probably need 489cc9bbe1461f359f0b27c5e7645c17dda001ab1dRaph Levien // something like that for paint attributes (color, underline, 499cc9bbe1461f359f0b27c5e7645c17dda001ab1dRaph Levien // fake b/i, etc), as having those per-glyph is bloated. 509cc9bbe1461f359f0b27c5e7645c17dda001ab1dRaph Levien int font_ix; 519cc9bbe1461f359f0b27c5e7645c17dda001ab1dRaph Levien 529cc9bbe1461f359f0b27c5e7645c17dda001ab1dRaph Levien unsigned int glyph_id; 539cc9bbe1461f359f0b27c5e7645c17dda001ab1dRaph Levien float x; 549cc9bbe1461f359f0b27c5e7645c17dda001ab1dRaph Levien float y; 559cc9bbe1461f359f0b27c5e7645c17dda001ab1dRaph Levien}; 569cc9bbe1461f359f0b27c5e7645c17dda001ab1dRaph Levien 574d4e6bc8118d15542f1f2a9218f0f7a91a29474fRaph Levien// Internal state used during layout operation 584d4e6bc8118d15542f1f2a9218f0f7a91a29474fRaph Levienclass LayoutContext; 594d4e6bc8118d15542f1f2a9218f0f7a91a29474fRaph Levien 6001f526614431e3a0a6e1a48039e00b8a9b7d6fbfRaph Levienenum { 6101f526614431e3a0a6e1a48039e00b8a9b7d6fbfRaph Levien kBidi_LTR = 0, 6201f526614431e3a0a6e1a48039e00b8a9b7d6fbfRaph Levien kBidi_RTL = 1, 6301f526614431e3a0a6e1a48039e00b8a9b7d6fbfRaph Levien kBidi_Default_LTR = 2, 6401f526614431e3a0a6e1a48039e00b8a9b7d6fbfRaph Levien kBidi_Default_RTL = 3, 6501f526614431e3a0a6e1a48039e00b8a9b7d6fbfRaph Levien kBidi_Force_LTR = 4, 6601f526614431e3a0a6e1a48039e00b8a9b7d6fbfRaph Levien kBidi_Force_RTL = 5, 6701f526614431e3a0a6e1a48039e00b8a9b7d6fbfRaph Levien 6801f526614431e3a0a6e1a48039e00b8a9b7d6fbfRaph Levien kBidi_Mask = 0x7 6901f526614431e3a0a6e1a48039e00b8a9b7d6fbfRaph Levien}; 7001f526614431e3a0a6e1a48039e00b8a9b7d6fbfRaph Levien 71c31e3883456e018d742e9f29815ba5ff8b315ea1Raph Levien// Lifecycle and threading assumptions for Layout: 72c31e3883456e018d742e9f29815ba5ff8b315ea1Raph Levien// The object is assumed to be owned by a single thread; multiple threads 73c31e3883456e018d742e9f29815ba5ff8b315ea1Raph Levien// may not mutate it at the same time. 74c31e3883456e018d742e9f29815ba5ff8b315ea1Raph Levien// The lifetime of the FontCollection set through setFontCollection must 75c31e3883456e018d742e9f29815ba5ff8b315ea1Raph Levien// extend through the lifetime of the Layout object. 769cc9bbe1461f359f0b27c5e7645c17dda001ab1dRaph Levienclass Layout { 779cc9bbe1461f359f0b27c5e7645c17dda001ab1dRaph Levienpublic: 786da7796cbe8a17efd61a3302369e69bb222fdb4fBehdad Esfahbod 796da7796cbe8a17efd61a3302369e69bb222fdb4fBehdad Esfahbod Layout() : mGlyphs(), mAdvances(), mCollection(0), mFaces(), mAdvance(0), mBounds() { 806da7796cbe8a17efd61a3302369e69bb222fdb4fBehdad Esfahbod mBounds.setEmpty(); 816da7796cbe8a17efd61a3302369e69bb222fdb4fBehdad Esfahbod } 826da7796cbe8a17efd61a3302369e69bb222fdb4fBehdad Esfahbod 836da7796cbe8a17efd61a3302369e69bb222fdb4fBehdad Esfahbod // Clears layout, ready to be used again 846da7796cbe8a17efd61a3302369e69bb222fdb4fBehdad Esfahbod void reset(); 856da7796cbe8a17efd61a3302369e69bb222fdb4fBehdad Esfahbod 869cc9bbe1461f359f0b27c5e7645c17dda001ab1dRaph Levien void dump() const; 87ecc2d34ac23a497988f21e5f415b53c007b9d8c5Raph Levien void setFontCollection(const FontCollection* collection); 884d4e6bc8118d15542f1f2a9218f0f7a91a29474fRaph Levien 8909f1901d6befcab49ed46cb77151a5d4af14a3b9Behdad Esfahbod void doLayout(const uint16_t* buf, size_t start, size_t count, size_t bufSize, 9009f1901d6befcab49ed46cb77151a5d4af14a3b9Behdad Esfahbod int bidiFlags, const FontStyle &style, const MinikinPaint &paint); 9109f1901d6befcab49ed46cb77151a5d4af14a3b9Behdad Esfahbod 924d4e6bc8118d15542f1f2a9218f0f7a91a29474fRaph Levien void draw(Bitmap*, int x0, int y0, float size) const; 934d4e6bc8118d15542f1f2a9218f0f7a91a29474fRaph Levien 946da7796cbe8a17efd61a3302369e69bb222fdb4fBehdad Esfahbod // Deprecated. Nont needed. Remove when callers are removed. 959cc9bbe1461f359f0b27c5e7645c17dda001ab1dRaph Levien static void init(); 96ecc2d34ac23a497988f21e5f415b53c007b9d8c5Raph Levien 97ecc2d34ac23a497988f21e5f415b53c007b9d8c5Raph Levien // public accessors 98ecc2d34ac23a497988f21e5f415b53c007b9d8c5Raph Levien size_t nGlyphs() const; 99ecc2d34ac23a497988f21e5f415b53c007b9d8c5Raph Levien // Does not bump reference; ownership is still layout 100ecc2d34ac23a497988f21e5f415b53c007b9d8c5Raph Levien MinikinFont *getFont(int i) const; 1019a5f713add8cfb91ac2c9ed5c917309053201ab6Raph Levien FontFakery getFakery(int i) const; 102ecc2d34ac23a497988f21e5f415b53c007b9d8c5Raph Levien unsigned int getGlyphId(int i) const; 103ecc2d34ac23a497988f21e5f415b53c007b9d8c5Raph Levien float getX(int i) const; 104ecc2d34ac23a497988f21e5f415b53c007b9d8c5Raph Levien float getY(int i) const; 105ecc2d34ac23a497988f21e5f415b53c007b9d8c5Raph Levien 106ecc2d34ac23a497988f21e5f415b53c007b9d8c5Raph Levien float getAdvance() const; 107ecc2d34ac23a497988f21e5f415b53c007b9d8c5Raph Levien 108ecc2d34ac23a497988f21e5f415b53c007b9d8c5Raph Levien // Get advances, copying into caller-provided buffer. The size of this 109ecc2d34ac23a497988f21e5f415b53c007b9d8c5Raph Levien // buffer must match the length of the string (nchars arg to doLayout). 110ecc2d34ac23a497988f21e5f415b53c007b9d8c5Raph Levien void getAdvances(float* advances); 111ecc2d34ac23a497988f21e5f415b53c007b9d8c5Raph Levien 112ecc2d34ac23a497988f21e5f415b53c007b9d8c5Raph Levien void getBounds(MinikinRect* rect); 113ecc2d34ac23a497988f21e5f415b53c007b9d8c5Raph Levien 11422e41754f6470ff1f4c0e0a56d01f7f555b59e21Raph Levien // Purge all caches, useful in low memory conditions 11522e41754f6470ff1f4c0e0a56d01f7f555b59e21Raph Levien static void purgeCaches(); 11622e41754f6470ff1f4c0e0a56d01f7f555b59e21Raph Levien 1179cc9bbe1461f359f0b27c5e7645c17dda001ab1dRaph Levienprivate: 118288c915963b3500c7efb958ba613650e2ecdfdfaBehdad Esfahbod friend class LayoutCacheKey; 119288c915963b3500c7efb958ba613650e2ecdfdfaBehdad Esfahbod 1209cc9bbe1461f359f0b27c5e7645c17dda001ab1dRaph Levien // Find a face in the mFaces vector, or create a new entry 1219a5f713add8cfb91ac2c9ed5c917309053201ab6Raph Levien int findFace(FakedFont face, LayoutContext* ctx); 1224d4e6bc8118d15542f1f2a9218f0f7a91a29474fRaph Levien 1234d4e6bc8118d15542f1f2a9218f0f7a91a29474fRaph Levien // Lay out a single bidi run 1244d4e6bc8118d15542f1f2a9218f0f7a91a29474fRaph Levien void doLayoutRunCached(const uint16_t* buf, size_t start, size_t count, size_t bufSize, 1253f1ea5da2ee12b0d95c17c56928c3e553d4eeda0Raph Levien bool isRtl, LayoutContext* ctx, size_t dstStart); 1264d4e6bc8118d15542f1f2a9218f0f7a91a29474fRaph Levien 1274d4e6bc8118d15542f1f2a9218f0f7a91a29474fRaph Levien // Lay out a single word 1284d4e6bc8118d15542f1f2a9218f0f7a91a29474fRaph Levien void doLayoutWord(const uint16_t* buf, size_t start, size_t count, size_t bufSize, 1294d4e6bc8118d15542f1f2a9218f0f7a91a29474fRaph Levien bool isRtl, LayoutContext* ctx, size_t bufStart); 1309cc9bbe1461f359f0b27c5e7645c17dda001ab1dRaph Levien 13186fa46c5ebb0d2c3319e08f4fbf487d8c2abbbfcRaph Levien // Lay out a single bidi run 13286fa46c5ebb0d2c3319e08f4fbf487d8c2abbbfcRaph Levien void doLayoutRun(const uint16_t* buf, size_t start, size_t count, size_t bufSize, 1334d4e6bc8118d15542f1f2a9218f0f7a91a29474fRaph Levien bool isRtl, LayoutContext* ctx); 1344d4e6bc8118d15542f1f2a9218f0f7a91a29474fRaph Levien 1354d4e6bc8118d15542f1f2a9218f0f7a91a29474fRaph Levien // Append another layout (for example, cached value) into this one 1364d4e6bc8118d15542f1f2a9218f0f7a91a29474fRaph Levien void appendLayout(Layout* src, size_t start); 1374d4e6bc8118d15542f1f2a9218f0f7a91a29474fRaph Levien 1389cc9bbe1461f359f0b27c5e7645c17dda001ab1dRaph Levien std::vector<LayoutGlyph> mGlyphs; 139ecc2d34ac23a497988f21e5f415b53c007b9d8c5Raph Levien std::vector<float> mAdvances; 1409cc9bbe1461f359f0b27c5e7645c17dda001ab1dRaph Levien 141ecc2d34ac23a497988f21e5f415b53c007b9d8c5Raph Levien const FontCollection* mCollection; 1429a5f713add8cfb91ac2c9ed5c917309053201ab6Raph Levien std::vector<FakedFont> mFaces; 143bcc3dc5a2591a95a57e379e27cbad69c18e91e67Raph Levien float mAdvance; 144ecc2d34ac23a497988f21e5f415b53c007b9d8c5Raph Levien MinikinRect mBounds; 1459cc9bbe1461f359f0b27c5e7645c17dda001ab1dRaph Levien}; 1469cc9bbe1461f359f0b27c5e7645c17dda001ab1dRaph Levien 1479cc9bbe1461f359f0b27c5e7645c17dda001ab1dRaph Levien} // namespace android 1489cc9bbe1461f359f0b27c5e7645c17dda001ab1dRaph Levien 1499cc9bbe1461f359f0b27c5e7645c17dda001ab1dRaph Levien#endif // MINIKIN_LAYOUT_H 150