Layout.h revision 09f1901d6befcab49ed46cb77151a5d4af14a3b9
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/CssParse.h> 259cc9bbe1461f359f0b27c5e7645c17dda001ab1dRaph Levien#include <minikin/FontCollection.h> 26bcc3dc5a2591a95a57e379e27cbad69c18e91e67Raph Levien#include <minikin/MinikinFontFreeType.h> 279cc9bbe1461f359f0b27c5e7645c17dda001ab1dRaph Levien 289cc9bbe1461f359f0b27c5e7645c17dda001ab1dRaph Leviennamespace android { 299cc9bbe1461f359f0b27c5e7645c17dda001ab1dRaph Levien 309cc9bbe1461f359f0b27c5e7645c17dda001ab1dRaph Levien// The Bitmap class is for debugging. We'll probably move it out 319cc9bbe1461f359f0b27c5e7645c17dda001ab1dRaph Levien// of here into a separate lightweight software rendering module 329cc9bbe1461f359f0b27c5e7645c17dda001ab1dRaph Levien// (optional, as we'd hope most clients would do their own) 339cc9bbe1461f359f0b27c5e7645c17dda001ab1dRaph Levienclass Bitmap { 349cc9bbe1461f359f0b27c5e7645c17dda001ab1dRaph Levienpublic: 359cc9bbe1461f359f0b27c5e7645c17dda001ab1dRaph Levien Bitmap(int width, int height); 369cc9bbe1461f359f0b27c5e7645c17dda001ab1dRaph Levien ~Bitmap(); 379cc9bbe1461f359f0b27c5e7645c17dda001ab1dRaph Levien void writePnm(std::ofstream& o) const; 38bcc3dc5a2591a95a57e379e27cbad69c18e91e67Raph Levien void drawGlyph(const GlyphBitmap& bitmap, int x, int y); 399cc9bbe1461f359f0b27c5e7645c17dda001ab1dRaph Levienprivate: 409cc9bbe1461f359f0b27c5e7645c17dda001ab1dRaph Levien int width; 419cc9bbe1461f359f0b27c5e7645c17dda001ab1dRaph Levien int height; 429cc9bbe1461f359f0b27c5e7645c17dda001ab1dRaph Levien uint8_t* buf; 439cc9bbe1461f359f0b27c5e7645c17dda001ab1dRaph Levien}; 449cc9bbe1461f359f0b27c5e7645c17dda001ab1dRaph Levien 459cc9bbe1461f359f0b27c5e7645c17dda001ab1dRaph Levienstruct LayoutGlyph { 469cc9bbe1461f359f0b27c5e7645c17dda001ab1dRaph Levien // index into mFaces and mHbFonts vectors. We could imagine 479cc9bbe1461f359f0b27c5e7645c17dda001ab1dRaph Levien // moving this into a run length representation, because it's 489cc9bbe1461f359f0b27c5e7645c17dda001ab1dRaph Levien // more efficient for long strings, and we'll probably need 499cc9bbe1461f359f0b27c5e7645c17dda001ab1dRaph Levien // something like that for paint attributes (color, underline, 509cc9bbe1461f359f0b27c5e7645c17dda001ab1dRaph Levien // fake b/i, etc), as having those per-glyph is bloated. 519cc9bbe1461f359f0b27c5e7645c17dda001ab1dRaph Levien int font_ix; 529cc9bbe1461f359f0b27c5e7645c17dda001ab1dRaph Levien 539cc9bbe1461f359f0b27c5e7645c17dda001ab1dRaph Levien unsigned int glyph_id; 549cc9bbe1461f359f0b27c5e7645c17dda001ab1dRaph Levien float x; 559cc9bbe1461f359f0b27c5e7645c17dda001ab1dRaph Levien float y; 569cc9bbe1461f359f0b27c5e7645c17dda001ab1dRaph Levien}; 579cc9bbe1461f359f0b27c5e7645c17dda001ab1dRaph Levien 584d4e6bc8118d15542f1f2a9218f0f7a91a29474fRaph Levien// Internal state used during layout operation 594d4e6bc8118d15542f1f2a9218f0f7a91a29474fRaph Levienclass LayoutContext; 604d4e6bc8118d15542f1f2a9218f0f7a91a29474fRaph Levien 61c31e3883456e018d742e9f29815ba5ff8b315ea1Raph Levien// Lifecycle and threading assumptions for Layout: 62c31e3883456e018d742e9f29815ba5ff8b315ea1Raph Levien// The object is assumed to be owned by a single thread; multiple threads 63c31e3883456e018d742e9f29815ba5ff8b315ea1Raph Levien// may not mutate it at the same time. 64c31e3883456e018d742e9f29815ba5ff8b315ea1Raph Levien// The lifetime of the FontCollection set through setFontCollection must 65c31e3883456e018d742e9f29815ba5ff8b315ea1Raph Levien// extend through the lifetime of the Layout object. 669cc9bbe1461f359f0b27c5e7645c17dda001ab1dRaph Levienclass Layout { 679cc9bbe1461f359f0b27c5e7645c17dda001ab1dRaph Levienpublic: 689cc9bbe1461f359f0b27c5e7645c17dda001ab1dRaph Levien void dump() const; 69ecc2d34ac23a497988f21e5f415b53c007b9d8c5Raph Levien void setFontCollection(const FontCollection* collection); 704d4e6bc8118d15542f1f2a9218f0f7a91a29474fRaph Levien 7109f1901d6befcab49ed46cb77151a5d4af14a3b9Behdad Esfahbod // Deprecated. Will be removed. 724d4e6bc8118d15542f1f2a9218f0f7a91a29474fRaph Levien void doLayout(const uint16_t* buf, size_t start, size_t count, size_t bufSize, 734d4e6bc8118d15542f1f2a9218f0f7a91a29474fRaph Levien const std::string& css); 744d4e6bc8118d15542f1f2a9218f0f7a91a29474fRaph Levien 7509f1901d6befcab49ed46cb77151a5d4af14a3b9Behdad Esfahbod void doLayout(const uint16_t* buf, size_t start, size_t count, size_t bufSize, 7609f1901d6befcab49ed46cb77151a5d4af14a3b9Behdad Esfahbod int bidiFlags, const FontStyle &style, const MinikinPaint &paint); 7709f1901d6befcab49ed46cb77151a5d4af14a3b9Behdad Esfahbod 784d4e6bc8118d15542f1f2a9218f0f7a91a29474fRaph Levien void draw(Bitmap*, int x0, int y0, float size) const; 794d4e6bc8118d15542f1f2a9218f0f7a91a29474fRaph Levien 809cc9bbe1461f359f0b27c5e7645c17dda001ab1dRaph Levien // This must be called before any invocations. 81f0a1e5b2da5aaccbc1c010413365cd8c304cf5d9Behdad Esfahbod // TODO: probably have a factory instead 829cc9bbe1461f359f0b27c5e7645c17dda001ab1dRaph Levien static void init(); 83ecc2d34ac23a497988f21e5f415b53c007b9d8c5Raph Levien 84ecc2d34ac23a497988f21e5f415b53c007b9d8c5Raph Levien // public accessors 85ecc2d34ac23a497988f21e5f415b53c007b9d8c5Raph Levien size_t nGlyphs() const; 86ecc2d34ac23a497988f21e5f415b53c007b9d8c5Raph Levien // Does not bump reference; ownership is still layout 87ecc2d34ac23a497988f21e5f415b53c007b9d8c5Raph Levien MinikinFont *getFont(int i) const; 889a5f713add8cfb91ac2c9ed5c917309053201ab6Raph Levien FontFakery getFakery(int i) const; 89ecc2d34ac23a497988f21e5f415b53c007b9d8c5Raph Levien unsigned int getGlyphId(int i) const; 90ecc2d34ac23a497988f21e5f415b53c007b9d8c5Raph Levien float getX(int i) const; 91ecc2d34ac23a497988f21e5f415b53c007b9d8c5Raph Levien float getY(int i) const; 92ecc2d34ac23a497988f21e5f415b53c007b9d8c5Raph Levien 93ecc2d34ac23a497988f21e5f415b53c007b9d8c5Raph Levien float getAdvance() const; 94ecc2d34ac23a497988f21e5f415b53c007b9d8c5Raph Levien 95ecc2d34ac23a497988f21e5f415b53c007b9d8c5Raph Levien // Get advances, copying into caller-provided buffer. The size of this 96ecc2d34ac23a497988f21e5f415b53c007b9d8c5Raph Levien // buffer must match the length of the string (nchars arg to doLayout). 97ecc2d34ac23a497988f21e5f415b53c007b9d8c5Raph Levien void getAdvances(float* advances); 98ecc2d34ac23a497988f21e5f415b53c007b9d8c5Raph Levien 99ecc2d34ac23a497988f21e5f415b53c007b9d8c5Raph Levien void getBounds(MinikinRect* rect); 100ecc2d34ac23a497988f21e5f415b53c007b9d8c5Raph Levien 10122e41754f6470ff1f4c0e0a56d01f7f555b59e21Raph Levien // Purge all caches, useful in low memory conditions 10222e41754f6470ff1f4c0e0a56d01f7f555b59e21Raph Levien static void purgeCaches(); 10322e41754f6470ff1f4c0e0a56d01f7f555b59e21Raph Levien 1049cc9bbe1461f359f0b27c5e7645c17dda001ab1dRaph Levienprivate: 1059cc9bbe1461f359f0b27c5e7645c17dda001ab1dRaph Levien // Find a face in the mFaces vector, or create a new entry 1069a5f713add8cfb91ac2c9ed5c917309053201ab6Raph Levien int findFace(FakedFont face, LayoutContext* ctx); 1074d4e6bc8118d15542f1f2a9218f0f7a91a29474fRaph Levien 1084d4e6bc8118d15542f1f2a9218f0f7a91a29474fRaph Levien // Lay out a single bidi run 1094d4e6bc8118d15542f1f2a9218f0f7a91a29474fRaph Levien void doLayoutRunCached(const uint16_t* buf, size_t start, size_t count, size_t bufSize, 1103f1ea5da2ee12b0d95c17c56928c3e553d4eeda0Raph Levien bool isRtl, LayoutContext* ctx, size_t dstStart); 1114d4e6bc8118d15542f1f2a9218f0f7a91a29474fRaph Levien 1124d4e6bc8118d15542f1f2a9218f0f7a91a29474fRaph Levien // Lay out a single word 1134d4e6bc8118d15542f1f2a9218f0f7a91a29474fRaph Levien void doLayoutWord(const uint16_t* buf, size_t start, size_t count, size_t bufSize, 1144d4e6bc8118d15542f1f2a9218f0f7a91a29474fRaph Levien bool isRtl, LayoutContext* ctx, size_t bufStart); 1159cc9bbe1461f359f0b27c5e7645c17dda001ab1dRaph Levien 11686fa46c5ebb0d2c3319e08f4fbf487d8c2abbbfcRaph Levien // Lay out a single bidi run 11786fa46c5ebb0d2c3319e08f4fbf487d8c2abbbfcRaph Levien void doLayoutRun(const uint16_t* buf, size_t start, size_t count, size_t bufSize, 1184d4e6bc8118d15542f1f2a9218f0f7a91a29474fRaph Levien bool isRtl, LayoutContext* ctx); 1194d4e6bc8118d15542f1f2a9218f0f7a91a29474fRaph Levien 1204d4e6bc8118d15542f1f2a9218f0f7a91a29474fRaph Levien // Append another layout (for example, cached value) into this one 1214d4e6bc8118d15542f1f2a9218f0f7a91a29474fRaph Levien void appendLayout(Layout* src, size_t start); 1224d4e6bc8118d15542f1f2a9218f0f7a91a29474fRaph Levien 1239cc9bbe1461f359f0b27c5e7645c17dda001ab1dRaph Levien std::vector<LayoutGlyph> mGlyphs; 124ecc2d34ac23a497988f21e5f415b53c007b9d8c5Raph Levien std::vector<float> mAdvances; 1259cc9bbe1461f359f0b27c5e7645c17dda001ab1dRaph Levien 126ecc2d34ac23a497988f21e5f415b53c007b9d8c5Raph Levien const FontCollection* mCollection; 1279a5f713add8cfb91ac2c9ed5c917309053201ab6Raph Levien std::vector<FakedFont> mFaces; 128bcc3dc5a2591a95a57e379e27cbad69c18e91e67Raph Levien float mAdvance; 129ecc2d34ac23a497988f21e5f415b53c007b9d8c5Raph Levien MinikinRect mBounds; 1309cc9bbe1461f359f0b27c5e7645c17dda001ab1dRaph Levien}; 1319cc9bbe1461f359f0b27c5e7645c17dda001ab1dRaph Levien 1329cc9bbe1461f359f0b27c5e7645c17dda001ab1dRaph Levien} // namespace android 1339cc9bbe1461f359f0b27c5e7645c17dda001ab1dRaph Levien 1349cc9bbe1461f359f0b27c5e7645c17dda001ab1dRaph Levien#endif // MINIKIN_LAYOUT_H 135