sij/mapnik
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Merge pull request #3688 from mapnik/font-engine-singleton

Browse source 
make font-engine-singleton to have better control over objects life-t…
This commit is contained in:
Artem Pavlenko 2017-06-01 11:31:18 +02:00 committed by GitHub
commit 98fa7699f3
13 changed files with 160 additions and 112 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

25
benchmark/test_face_ptr_creation.cpp
View file

@ -10,39 +10,39 @@ public:
bool validate() const
{
std::size_t count = 0;
std::size_t expected_count = mapnik::freetype_engine::face_names().size();
std::size_t expected_count = mapnik::freetype_engine::instance().face_names().size();
mapnik::freetype_engine::font_file_mapping_type font_file_mapping;
mapnik::freetype_engine::font_memory_cache_type font_cache;
mapnik::font_library library;
for (std::string const& name : mapnik::freetype_engine::face_names())
for (std::string const& name : mapnik::freetype_engine::instance().face_names())
{
mapnik::face_ptr f = mapnik::freetype_engine::create_face(name,
mapnik::face_ptr f = mapnik::freetype_engine::instance().create_face(name,
library,
font_file_mapping,
font_cache,
mapnik::freetype_engine::get_mapping(),
mapnik::freetype_engine::get_cache());
mapnik::freetype_engine::instance().get_mapping(),
mapnik::freetype_engine::instance().get_cache());
if (f) ++count;
}
return count == expected_count;
}
bool operator()() const
{
std::size_t expected_count = mapnik::freetype_engine::face_names().size();
std::size_t expected_count = mapnik::freetype_engine::instance().face_names().size();
for (unsigned i=0;i<iterations_;++i)
{
std::size_t count = 0;
mapnik::freetype_engine::font_file_mapping_type font_file_mapping;
mapnik::freetype_engine::font_memory_cache_type font_cache;
mapnik::font_library library;
for (std::string const& name : mapnik::freetype_engine::face_names())
for (std::string const& name : mapnik::freetype_engine::instance().face_names())
{
mapnik::face_ptr f = mapnik::freetype_engine::create_face(name,
mapnik::face_ptr f = mapnik::freetype_engine::instance().create_face(name,
library,
font_file_mapping,
font_cache,
mapnik::freetype_engine::get_mapping(),
mapnik::freetype_engine::get_cache());
mapnik::freetype_engine::instance().get_mapping(),
mapnik::freetype_engine::instance().get_cache());
if (f) ++count;
}
if (count != expected_count) {
@ -57,13 +57,12 @@ int main(int argc, char** argv)
{
mapnik::parameters params;
benchmark::handle_args(argc,argv,params);
bool success = mapnik::freetype_engine::register_fonts("./fonts", true);
bool success = mapnik::freetype_engine::instance().register_fonts("./fonts", true);
if (!success) {
std::clog << "warning, did not register any new fonts!\n";
return -1;
}
std::size_t face_count = mapnik::freetype_engine::face_names().size();
std::size_t face_count = mapnik::freetype_engine::instance().face_names().size();
test test_runner(params);
return run(test_runner,(boost::format("font_engine: creating %ld faces") % (face_count)).str());
}

4
benchmark/test_font_registration.cpp
View file

@ -10,14 +10,14 @@ public:
: test_case(params) {}
bool validate() const
{
return mapnik::freetype_engine::register_fonts("./fonts", true);
return mapnik::freetype_engine::instance().register_fonts("./fonts", true);
}
bool operator()() const
{
unsigned long count = 0;
for (unsigned i=0;i<iterations_;++i)
{
mapnik::freetype_engine::register_fonts("./fonts", true);
mapnik::freetype_engine::instance().register_fonts("./fonts", true);
count++;
}
return true;

2
benchmark/test_rendering.cpp
View file

@ -99,7 +99,7 @@ int main(int argc, char** argv)
std::clog << "please provide a name for this test\n";
return -1;
}
mapnik::freetype_engine::register_fonts("./fonts/",true);
mapnik::freetype_engine::instance().register_fonts("./fonts/",true);
mapnik::datasource_cache::instance().register_datasources("./plugins/input/");
{
test test_runner(params);

2
benchmark/test_rendering_shared_map.cpp
View file

@ -156,7 +156,7 @@ int main(int argc, char** argv)
std::clog << "please provide a name for this test\n";
return -1;
}
mapnik::freetype_engine::register_fonts("./fonts/",true);
mapnik::freetype_engine::instance().register_fonts("./fonts/",true);
mapnik::datasource_cache::instance().register_datasources("./plugins/input/");
{
test test_runner(params);

2
demo/c++/rundemo.cpp
View file

@ -55,7 +55,7 @@ int main ( int, char** )
try {
std::cout << " running demo ... \n";
datasource_cache::instance().register_datasources("plugins/input/");
freetype_engine::register_font("fonts/dejavu-fonts-ttf-2.37/ttf/DejaVuSans.ttf");
freetype_engine::instance().register_font("fonts/dejavu-fonts-ttf-2.37/ttf/DejaVuSans.ttf");
Map m(800,600);
m.set_background(parse_color("white"));

2
demo/viewer/main.cpp
View file

@ -48,7 +48,7 @@ int main( int argc, char **argv )
{
settings.setArrayIndex(index);
QString font_dir = settings.value("dir").toString();
freetype_engine::register_fonts(font_dir.toStdString());
freetype_engine::instance().register_fonts(font_dir.toStdString());
}
settings.endArray();

61
include/mapnik/font_engine_freetype.hpp
View file

@ -25,9 +25,10 @@
// mapnik
#include <mapnik/config.hpp>
#include <mapnik/util/singleton.hpp>
#include <mapnik/util/noncopyable.hpp>
#include <mapnik/font_set.hpp>
#include <mapnik/text/font_library.hpp>
#include <mapnik/util/noncopyable.hpp>
// stl
#include <memory>
@ -35,10 +36,6 @@
#include <utility> // pair
#include <vector>
#ifdef MAPNIK_THREADSAFE
#include <mutex>
#endif
namespace boost { template <class T> class optional; }
namespace mapnik
@ -51,22 +48,17 @@ using face_set_ptr = std::unique_ptr<font_face_set>;
class font_face;
using face_ptr = std::shared_ptr<font_face>;
class MAPNIK_DECL freetype_engine
class MAPNIK_DECL freetype_engine : public singleton<freetype_engine, CreateUsingNew>,
private util::noncopyable
{
friend class CreateUsingNew<freetype_engine>;
friend class Map;
public:
using font_file_mapping_type = std::map<std::string,std::pair<int,std::string>>;
using font_memory_cache_type = std::map<std::string, std::pair<std::unique_ptr<char[]>, std::size_t>>;
static bool is_font_file(std::string const& file_name);
/*! \brief register a font file
* @param file_name path to a font file.
* @return bool - true if at least one face was successfully registered in the file.
*/
static bool register_font(std::string const& file_name);
/*! \brief register a font files
* @param dir - path to a directory containing fonts or subdirectories.
* @param recurse - default false, whether to search for fonts in sub directories.
* @return bool - true if at least one face was successfully registered.
*/
static bool register_fonts(std::string const& dir, bool recurse = false);
static std::vector<std::string> face_names();
static font_file_mapping_type const& get_mapping();
@ -75,29 +67,42 @@ public:
font_library & library,
font_file_mapping_type const& font_file_mapping,
font_file_mapping_type const& global_font_file_mapping);
static face_ptr create_face(std::string const& face_name,
font_library & library,
font_file_mapping_type const& font_file_mapping,
freetype_engine::font_memory_cache_type const& font_cache,
font_file_mapping_type const& global_font_file_mapping,
freetype_engine::font_memory_cache_type & global_memory_fonts);
static bool register_font_impl(std::string const& file_name,
private:
bool is_font_file_impl(std::string const& file_name);
std::vector<std::string> face_names_impl();
font_file_mapping_type const& get_mapping_impl();
font_memory_cache_type& get_cache_impl();
bool can_open_impl(std::string const& face_name,
font_library & library,
font_file_mapping_type const& font_file_mapping,
font_file_mapping_type const& global_font_file_mapping);
face_ptr create_face_impl(std::string const& face_name,
font_library & library,
font_file_mapping_type const& font_file_mapping,
freetype_engine::font_memory_cache_type const& font_cache,
font_file_mapping_type const& global_font_file_mapping,
freetype_engine::font_memory_cache_type & global_memory_fonts);
bool register_font_impl(std::string const& file_name);
bool register_fonts_impl(std::string const& dir, bool recurse);
bool register_font_impl(std::string const& file_name, FT_LibraryRec_ * library);
bool register_fonts_impl(std::string const& dir, FT_LibraryRec_ * library, bool recurse = false);
bool register_font_impl(std::string const& file_name,
font_library & libary,
font_file_mapping_type & font_file_mapping);
static bool register_fonts_impl(std::string const& dir,
bool register_fonts_impl(std::string const& dir,
font_library & libary,
font_file_mapping_type & font_file_mapping,
bool recurse = false);
virtual ~freetype_engine();
freetype_engine();
private:
static bool register_font_impl(std::string const& file_name, FT_LibraryRec_ * library);
static bool register_fonts_impl(std::string const& dir, FT_LibraryRec_ * library, bool recurse = false);
#ifdef MAPNIK_THREADSAFE
static std::mutex mutex_;
#endif
static font_file_mapping_type global_font_file_mapping_;
static font_memory_cache_type global_memory_fonts_;
font_file_mapping_type global_font_file_mapping_;
font_memory_cache_type global_memory_fonts_;
};
class MAPNIK_DECL face_manager
@ -124,7 +129,7 @@ private:
};
using face_manager_freetype = face_manager;
extern template class MAPNIK_DECL singleton<freetype_engine, CreateUsingNew>;
}
#endif // MAPNIK_FONT_ENGINE_FREETYPE_HPP

64
src/font_engine_freetype.cpp
View file

@ -51,9 +51,7 @@ extern "C"
namespace mapnik
{
freetype_engine::freetype_engine() {}
freetype_engine::~freetype_engine() {}
template class MAPNIK_DECL singleton<freetype_engine, CreateUsingNew>;
bool freetype_engine::is_font_file(std::string const& file_name)
{
@ -79,6 +77,11 @@ unsigned long ft_read_cb(FT_Stream stream, unsigned long offset, unsigned char *
}
bool freetype_engine::register_font(std::string const& file_name)
{
return instance().register_font_impl(file_name);
}
bool freetype_engine::register_font_impl(std::string const& file_name)
{
#ifdef MAPNIK_THREADSAFE
std::lock_guard<std::mutex> lock(mutex_);
@ -161,6 +164,11 @@ bool freetype_engine::register_font_impl(std::string const& file_name,
}
bool freetype_engine::register_fonts(std::string const& dir, bool recurse)
{
return instance().register_fonts_impl(dir, recurse);
}
bool freetype_engine::register_fonts_impl(std::string const& dir, bool recurse)
{
#ifdef MAPNIK_THREADSAFE
std::lock_guard<std::mutex> lock(mutex_);
@ -216,8 +224,12 @@ bool freetype_engine::register_fonts_impl(std::string const& dir,
return success;
}
std::vector<std::string> freetype_engine::face_names()
{
return instance().face_names_impl();
}
std::vector<std::string> freetype_engine::face_names_impl()
{
std::vector<std::string> names;
for (auto const& kv : global_font_file_mapping_)
@ -228,11 +240,21 @@ std::vector<std::string> freetype_engine::face_names ()
}
freetype_engine::font_file_mapping_type const& freetype_engine::get_mapping()
{
return instance().get_mapping_impl();
}
freetype_engine::font_file_mapping_type const& freetype_engine::get_mapping_impl()
{
return global_font_file_mapping_;
}
freetype_engine::font_memory_cache_type & freetype_engine::get_cache()
{
return instance().get_cache_impl();
}
freetype_engine::font_memory_cache_type & freetype_engine::get_cache_impl()
{
return global_memory_fonts_;
}
@ -241,6 +263,14 @@ bool freetype_engine::can_open(std::string const& face_name,
font_library & library,
font_file_mapping_type const& font_file_mapping,
font_file_mapping_type const& global_font_file_mapping)
{
return instance().can_open_impl(face_name, library, font_file_mapping, global_font_file_mapping);
}
bool freetype_engine::can_open_impl(std::string const& face_name,
font_library & library,
font_file_mapping_type const& font_file_mapping,
font_file_mapping_type const& global_font_file_mapping)
{
bool found_font_file = false;
font_file_mapping_type::const_iterator itr = font_file_mapping.find(face_name);
@ -279,7 +309,7 @@ bool freetype_engine::can_open(std::string const& face_name,
return true;
}
face_ptr freetype_engine::create_face(std::string const& family_name,
face_ptr freetype_engine::create_face_impl(std::string const& family_name,
font_library & library,
freetype_engine::font_file_mapping_type const& font_file_mapping,
freetype_engine::font_memory_cache_type const& font_cache,
@ -356,6 +386,20 @@ face_ptr freetype_engine::create_face(std::string const& family_name,
return face_ptr();
}
face_ptr freetype_engine::create_face(std::string const& family_name,
font_library & library,
freetype_engine::font_file_mapping_type const& font_file_mapping,
freetype_engine::font_memory_cache_type const& font_cache,
freetype_engine::font_file_mapping_type const& global_font_file_mapping,
freetype_engine::font_memory_cache_type & global_memory_fonts)
{
return instance().create_face_impl(family_name,
library,
font_file_mapping,
font_cache,
global_font_file_mapping,
global_memory_fonts);
}
face_manager::face_manager(font_library & library,
freetype_engine::font_file_mapping_type const& font_file_mapping,
@ -386,8 +430,8 @@ face_ptr face_manager::get_face(std::string const& name)
library_,
font_file_mapping_,
font_memory_cache_,
freetype_engine::get_mapping(),
freetype_engine::get_cache());
freetype_engine::instance().get_mapping(),
freetype_engine::instance().get_cache());
if (face)
{
face_cache_->emplace(name, face);
@ -442,9 +486,9 @@ face_set_ptr face_manager::get_face_set(std::string const& name, boost::optional
}
#ifdef MAPNIK_THREADSAFE
std::mutex freetype_engine::mutex_;
//std::mutex freetype_engine::mutex_;
#endif
freetype_engine::font_file_mapping_type freetype_engine::global_font_file_mapping_;
freetype_engine::font_memory_cache_type freetype_engine::global_memory_fonts_;
//freetype_engine::font_file_mapping_type freetype_engine::global_font_file_mapping_;
//freetype_engine::font_memory_cache_type freetype_engine::global_memory_fonts_;
}

8
src/load_map.cpp
View file

@ -536,10 +536,10 @@ bool map_parser::parse_font(font_set & fset, xml_node const& f)
}
else
{
found = freetype_engine::can_open(face_name,
found = freetype_engine::instance().can_open(face_name,
font_library_,
font_file_mapping_,
freetype_engine::get_mapping());
freetype_engine::instance().get_mapping());
font_name_cache_.emplace(face_name,found);
}
if (found)
@ -1599,10 +1599,10 @@ void map_parser::ensure_font_face(std::string const& face_name)
}
else
{
found = freetype_engine::can_open(face_name,
found = freetype_engine::instance().can_open(face_name,
font_library_,
font_file_mapping_,
freetype_engine::get_mapping());
freetype_engine::instance().get_mapping());
font_name_cache_.emplace(face_name,found);
}
if (!found)

4
src/map.cpp
View file

@ -285,13 +285,13 @@ std::map<std::string,font_set> & Map::fontsets()
bool Map::register_fonts(std::string const& dir, bool recurse)
{
font_library library;
return freetype_engine::register_fonts_impl(dir, library, font_file_mapping_, recurse);
return freetype_engine::instance().register_fonts_impl(dir, library, font_file_mapping_, recurse);
}
bool Map::load_fonts()
{
bool result = false;
auto const& global_mapping = freetype_engine::get_mapping();
auto const& global_mapping = freetype_engine::instance().get_mapping();
for (auto const& kv : font_file_mapping_) // for every face-name -> idx/filepath
{
auto const& file_path = kv.second.second;

56
test/standalone/font_registration_test.cpp
View file

@ -20,8 +20,8 @@ SECTION("registration") {
mapnik::logger::severity_type original_severity = logger.get_severity();
// grab references to global statics of registered/cached fonts
auto const& global_mapping = mapnik::freetype_engine::get_mapping();
auto const& global_cache = mapnik::freetype_engine::get_cache();
auto const& global_mapping = mapnik::freetype_engine::instance().get_mapping();
auto const& global_cache = mapnik::freetype_engine::instance().get_cache();
// mapnik.Map object has parallel structure for localized fonts
mapnik::Map m(1,1);
@ -62,11 +62,11 @@ SECTION("registration") {
std::vector<std::string> face_names;
std::string foo("foo");
// fake directories
REQUIRE( !mapnik::freetype_engine::register_fonts(foo , true ) );
face_names = mapnik::freetype_engine::face_names();
REQUIRE( !mapnik::freetype_engine::instance().register_fonts(foo , true ) );
face_names = mapnik::freetype_engine::instance().face_names();
REQUIRE( face_names.size() == 0 );
REQUIRE( !mapnik::freetype_engine::register_fonts(foo) );
face_names = mapnik::freetype_engine::face_names();
REQUIRE( !mapnik::freetype_engine::instance().register_fonts(foo) );
face_names = mapnik::freetype_engine::instance().face_names();
REQUIRE( face_names.size() == 0 );
// directories without fonts
@ -76,31 +76,31 @@ SECTION("registration") {
// an empty directory will not return true
// we need to register at least one font and not fail on any
// to return true
REQUIRE( mapnik::freetype_engine::register_font(src) == false );
REQUIRE( mapnik::freetype_engine::register_fonts(src, true) == false );
REQUIRE( mapnik::freetype_engine::face_names().size() == 0 );
REQUIRE( mapnik::freetype_engine::instance().register_font(src) == false );
REQUIRE( mapnik::freetype_engine::instance().register_fonts(src, true) == false );
REQUIRE( mapnik::freetype_engine::instance().face_names().size() == 0 );
// bogus, emtpy file that looks like font
REQUIRE( mapnik::freetype_engine::register_font("test/data/fonts/fake.ttf") == false );
REQUIRE( mapnik::freetype_engine::register_fonts("test/data/fonts/fake.ttf") == false );
REQUIRE( mapnik::freetype_engine::face_names().size() == 0 );
REQUIRE( mapnik::freetype_engine::instance().register_font("test/data/fonts/fake.ttf") == false );
REQUIRE( mapnik::freetype_engine::instance().register_fonts("test/data/fonts/fake.ttf") == false );
REQUIRE( mapnik::freetype_engine::instance().face_names().size() == 0 );
REQUIRE( mapnik::freetype_engine::register_font("test/data/fonts/intentionally-broken.ttf") == false );
REQUIRE( mapnik::freetype_engine::register_fonts("test/data/fonts/intentionally-broken.ttf") == false );
REQUIRE( mapnik::freetype_engine::face_names().size() == 0 );
REQUIRE( mapnik::freetype_engine::instance().register_font("test/data/fonts/intentionally-broken.ttf") == false );
REQUIRE( mapnik::freetype_engine::instance().register_fonts("test/data/fonts/intentionally-broken.ttf") == false );
REQUIRE( mapnik::freetype_engine::instance().face_names().size() == 0 );
// now restore the original severity
logger.set_severity(original_severity);
// single dejavu font in separate location
std::string dejavu_bold_oblique("test/data/fonts/DejaVuSansMono-BoldOblique.ttf");
REQUIRE( mapnik::freetype_engine::register_font(dejavu_bold_oblique) );
face_names = mapnik::freetype_engine::face_names();
REQUIRE( mapnik::freetype_engine::instance().register_font(dejavu_bold_oblique) );
face_names = mapnik::freetype_engine::instance().face_names();
REQUIRE( face_names.size() == 1 );
// now, inspect font mapping and confirm the correct 'DejaVu Sans Mono Bold Oblique' is registered
using font_file_mapping = std::map<std::string, std::pair<int,std::string> >;
font_file_mapping const& name2file = mapnik::freetype_engine::get_mapping();
font_file_mapping const& name2file = mapnik::freetype_engine::instance().get_mapping();
bool found_dejavu = false;
for (auto const& item : name2file)
{
@ -114,8 +114,8 @@ SECTION("registration") {
REQUIRE( found_dejavu );
// recurse to find all dejavu fonts
REQUIRE( mapnik::freetype_engine::register_fonts(fontdir, true) );
face_names = mapnik::freetype_engine::face_names();
REQUIRE( mapnik::freetype_engine::instance().register_fonts(fontdir, true) );
face_names = mapnik::freetype_engine::instance().face_names();
REQUIRE( face_names.size() == 22 );
// we should have re-registered 'DejaVu Sans Mono Bold Oblique' again,
@ -148,21 +148,21 @@ SECTION("registration") {
// check that we can correctly read a .ttc containing
// multiple valid faces
// https://github.com/mapnik/mapnik/issues/2274
REQUIRE( mapnik::freetype_engine::register_font("test/data/fonts/NotoSans-Regular.ttc") );
face_names = mapnik::freetype_engine::face_names();
REQUIRE( mapnik::freetype_engine::instance().register_font("test/data/fonts/NotoSans-Regular.ttc") );
face_names = mapnik::freetype_engine::instance().face_names();
REQUIRE( face_names.size() == 24 );
// now blindly register as many system fonts as possible
// the goal here to make sure we don't crash
// linux
mapnik::freetype_engine::register_fonts("/usr/share/fonts/", true);
mapnik::freetype_engine::register_fonts("/usr/local/share/fonts/", true);
mapnik::freetype_engine::instance().register_fonts("/usr/share/fonts/", true);
mapnik::freetype_engine::instance().register_fonts("/usr/local/share/fonts/", true);
// osx
mapnik::freetype_engine::register_fonts("/Library/Fonts/", true);
mapnik::freetype_engine::register_fonts("/System/Library/Fonts/", true);
mapnik::freetype_engine::instance().register_fonts("/Library/Fonts/", true);
mapnik::freetype_engine::instance().register_fonts("/System/Library/Fonts/", true);
// windows
mapnik::freetype_engine::register_fonts("C:\\Windows\\Fonts", true);
face_names = mapnik::freetype_engine::face_names();
mapnik::freetype_engine::instance().register_fonts("C:\\Windows\\Fonts", true);
face_names = mapnik::freetype_engine::instance().face_names();
REQUIRE( face_names.size() > 22 );
}
catch (std::exception const & ex)

2
test/visual/run.cpp
View file

@ -174,7 +174,7 @@ int main(int argc, char** argv)
}
#endif
mapnik::freetype_engine::register_fonts(vm["fonts"].as<std::string>(), true);
mapnik::freetype_engine::instance().register_fonts(vm["fonts"].as<std::string>(), true);
mapnik::datasource_cache::instance().register_datasources(vm["plugins"].as<std::string>());
boost::filesystem::path output_dir(vm["output-dir"].as<std::string>());

2
utils/mapnik-render/mapnik-render.cpp
View file

@ -104,7 +104,7 @@ int main (int argc,char** argv)
}
mapnik::datasource_cache::instance().register_datasources("./plugins/input/");
mapnik::freetype_engine::register_fonts("./fonts",true);
mapnik::freetype_engine::instance().register_fonts("./fonts",true);
mapnik::Map map(600,400);
mapnik::load_map(map,xml_file,true);
map.zoom_all();