harfbuzz / icu-le-hb Goto Github PK

ICU Layout Engine API on top of HarfBuzz shaping library

License: Other

Shell 0.23% Makefile 4.39% C++ 55.14% C 28.89% M4 11.35%

icu-le-hb's Introduction

HarfBuzz

HarfBuzz is a text shaping engine. It primarily supports OpenType, but also Apple Advanced Typography. HarfBuzz is used in Android, Chrome, ChromeOS, Firefox, GNOME, GTK+, KDE, Qt, LibreOffice, OpenJDK, XeTeX, PlayStation, Microsoft Edge, Adobe Photoshop, Illustrator, InDesign, Godot Engine, Unreal Engine, and other places.

For bug reports, mailing list, and other information please visit:

http://harfbuzz.org/

For license information, see COPYING.

Documentation

For user manual as well as API documentation, check: https://harfbuzz.github.io

Download

For tarball releases of HarfBuzz, look here. At the same place you will also find Win32/Win64 binary bundles that include libharfbuzz DLL, hb-view.exe, hb-shape.exe, and all dependencies.

The canonical source tree is available on github.

The API that comes with hb.h will not change incompatibly. Other, peripheral, headers are more likely to go through minor modifications, but again, we do our best to never change API in an incompatible way. We will never break the ABI.

If you are not sure whether Pango or HarfBuzz is right for you, read Pango vs HarfBuzz.

Development

For build information, see BUILD.md.

For custom configurations, see CONFIG.md.

For testing and profiling, see TESTING.md.

To get a better idea of where HarfBuzz stands in the text rendering stack you may want to read State of Text Rendering 2024. Here are a few presentation slides about HarfBuzz at the Internationalization and Unicode Conference over the years:

November 2014, Unicode, OpenType, and HarfBuzz: Closing the Circle,
October 2012, HarfBuzz, The Free and Open Text Shaping Engine,
October 2009, HarfBuzz: the Free and Open Shaping Engine.

Both development and user support discussion around HarfBuzz happens on the github.

To report bugs or submit patches please use github issues and pull-requests.

For a comparison of old vs new HarfBuzz memory consumption see this.

Name

HarfBuzz (حرف‌باز) is the literal Persian translation of “OpenType”, transliterated using the Latin script. It also means "talkative" or "glib" (also a nod to the GNOME project where HarfBuzz originates from).

Background: Originally there was this font format called TrueType. People and companies started calling their type engines all things ending in Type: FreeType, CoolType, ClearType, etc. And then came OpenType, which is the successor of TrueType. So, for my OpenType implementation, I decided to stick with the concept but use the Persian translation. Which is fitting given that Persian is written in the Arabic script, and OpenType is an extension of TrueType that adds support for complex script rendering, and HarfBuzz is an implementation of OpenType complex text shaping.

Packaging status of HarfBuzz

icu-le-hb's People

Contributors

Stargazers

Watchers

Forkers

srl295 xuhd uikit0 dm04806 elmarb dkuspawono jameslinus ezhangle mosesfor zapolnov rdhafidh patrickyoui sahwar hunter-packages acidburn0zzz kyawkyaw vendored light1707 isabella232

icu-le-hb's Issues

getCharIndices

are harfbuzz's CharIndices pre-indexed? I had to ignore the indexBase param to get the same value as ICU. Some mismatch here.

index b0bbe63..7d760fd 100644

--- a/src/LayoutEngine.cpp
+++ b/src/LayoutEngine.cpp
@@ -178,7 +178,7 @@ void LayoutEngine::getCharIndices(le_int32 charIndices[], le_int32 indexBase, LE
   unsigned int count;
   const hb_glyph_info_t *info = hb_buffer_get_glyph_infos (fHbBuffer, &count);
   for (unsigned int i = 0; i < count; i++)
-    charIndices[i] = info[i].cluster + indexBase;
+    charIndices[i] = info[i].cluster; // + indexBase;
 }

 void LayoutEngine::getCharIndices(le_int32 charIndices[], LEErrorCode &success) const

U+00AD should be visible hyphen

ICU layout treats U+00AD "soft hypen" as a visible hyphen; icu-le-hb does not. I'm aware that U+00AD is ambiguously defined, but if icu-le-hb aims to be a compatible replacement of ICU layout, then it should reproduce the visible U+00AD behavior.

Update to latest Unicode

http://bugs.icu-project.org/trac/changeset/37403

gitignore?

after autogen i 'git' this:

$ git status
# On branch master
# Untracked files:
#   (use "git add <file>..." to include in what will be committed)
#
#   INSTALL
#   Makefile.in
#   aclocal.m4
#   autom4te.cache/
#   config.guess
#   config.log
#   config.sub
#   configure
#   depcomp
#   install-sh
#   ltmain.sh
#   missing
#   src/Makefile.in

nothing added to commit but untracked files present (use "git add" to track)

need to specify C++11 as per ICU

for recent ICUs, will need to build this with options to specify C++11.

Failure:

$ make
Making all in src
  CXX      libicu_le_hb_la-LayoutEngine.lo
In file included from LayoutEngine.cpp:8:
In file included from ./LETypes.h:17:
/usr/local/Cellar/icu4c/67.1/include/unicode/uobject.h:134:54: error: expected ';' at end of declaration list
    static void * U_EXPORT2 operator new(size_t size) U_NOEXCEPT;
                                                     ^
                                                     ;

Solution (for mac):

make CXXFLAGS=-std=c++11

Add test suite

Right now I have no tests whatsoever for this...

icu-uc.pc - compile time only?

Is icu-uc.pc really needed at install time? Wondering if the icu-le-hb.pc should not depend on icu-uc.pc

Alternatively, maybe the wrapper should fold into ICU after all ( since iculx depends on icu-le-hb which depends on HB and icu-uc.. )