diff options
Diffstat (limited to 'font_lib/init.lua')
| -rw-r--r-- | font_lib/init.lua | 244 |
1 files changed, 154 insertions, 90 deletions
diff --git a/font_lib/init.lua b/font_lib/init.lua index 9b10e76..76a6b38 100644 --- a/font_lib/init.lua +++ b/font_lib/init.lua @@ -18,11 +18,18 @@ --]] -- Global variables +------------------- font_lib = {} -font_lib.path = minetest.get_modpath("font_lib") +font_lib.name = minetest.get_current_modname() +font_lib.path = minetest.get_modpath(font_lib.name) font_lib.registered_fonts = {} +-- Local variables +------------------ + +local default_font = false + -- Local functions ------------------ @@ -41,38 +48,41 @@ local function split_lines(text, maxlines) end end --- Returns next char, managing ascii and unicode plane 0 (0000-FFFF). +-- Gets a default (settings or fist font) -local function get_next_char(text, pos) - pos = pos + 1 - local char = text:sub(pos, pos):byte() +local function get_default_font() + -- First call + if default_font == false then + default_font = nil - -- 1 byte char - if char < 0x80 then - return char, pos - end + -- First, try with settings + local settings_font = minetest.settings:get("default_font") - -- 4 bytes char not managed - if char >= 0xF0 then - pos = pos + 3 - return 0, pos - end - - -- 3 bytes char not managed - if char >= 0xE0 then - pos = pos + 2 - return 0, pos - end - - -- 2 bytes char (little endian) - if char >= 0xC2 then - pos = pos + 1 - return (char - 0xC2) * 0x40 + text:sub(pos, pos):byte(), pos - end + if settings_font ~= nil and settings_font ~= "" then + default_font = font_lib.registered_fonts[settings_font] - -- Not an UTF char - return 0, pos + if default_font == nil then + minetest.log("warning", "Default font in settings (\"".. + settings_font.."\") is not registered.") + end + end + + -- If failed, choose first font + if default_font == nil then + for _, font in pairs(font_lib.registered_fonts) do + default_font = font + break + end + end + -- Error, no font registered + if default_font == nil then + minetest.log("error", + "No font registred, unable to choose a default font.") + end + end + + return default_font end -- Returns font properties to be used according to font_name @@ -81,7 +91,7 @@ local function get_font(font_name) local font = font_lib.registered_fonts[font_name] if font == nil then - local message + local message if font_name == nil then message = "No font given" @@ -89,17 +99,49 @@ local function get_font(font_name) message = "Font \""..font_name.."\" unregistered" end - if font_lib.fallback_font == nil then - minetest.log("error", message.." and no other font registered.") - else - minetest.log("info", message..", using font \""..font_lib.fallback_font.."\".") - font = font_lib.registered_fonts[font_lib.fallback_font] + font = get_default_font() + + if font ~= nil then + minetest.log("info", message..", using font \""..font.name.."\".") end end return font end +-- Returns next char, managing ascii and unicode plane 0 (0000-FFFF). + +local function get_next_char(text, pos) + + local msb = text:byte(pos) + -- 1 byte char, ascii equivalent codepoints + if msb < 0x80 then + return msb, pos + 1 + end + + -- 4 bytes char not managed (Only 16 bits codepoints are managed) + if msb >= 0xF0 then + return 0, pos + 4 + end + + -- 3 bytes char + if msb >= 0xE0 then + return (msb - 0xE0) * 0x1000 + + text:byte(pos + 1) % 0x40 * 0x40 + + text:byte(pos + 2) % 0x40, + pos + 3 + end + + -- 2 bytes char (little endian) + if msb >= 0xC2 then + return (msb - 0xC2) * 0x40 + text:byte(pos + 1), + pos + 2 + end + + -- Not an UTF char + return 0, pos + 1 +end + -- API functions ---------------- @@ -111,21 +153,23 @@ end function font_lib.get_text_size(font_name, text) local char local width = 0 - local pos = 0 + local pos = 1 local font = get_font(font_name) if font == nil then return 0, 0 else - while pos < #text do + while pos <= #text do char, pos = get_next_char(text, pos) - -- Ignore chars with no texture + -- Replace chars with no texture by the NULL(0) char if font.widths[char] ~= nil then width = width + font.widths[char] + else + width = width + font.widths[0] end end end - + return width, font.height end @@ -137,32 +181,33 @@ end -- @param y Vertical position of the line in texture -- @return Texture string ---> ADD ALIGN function font_lib.make_line_texture(font_name, text, width, x, y) local texture = "" local char - local pos = 0 + local pos = 1 local font = get_font(font_name) if font ~= nil then - while pos < #text do + while pos <= #text do char, pos = get_next_char(text, pos) - - -- Ignore chars with no texture - if font.widths[char] ~= nil then - -- Add image only if it is visible (at least partly) - if x + font.widths[char] >= 0 and x <= width then - texture = texture.. - string.format(":%d,%d=font_%s_%04x.png", - x, y, font.name, char) - end - x = x + font.widths[char] - else - print(string.format("Missing char %d (%04x)",char,char)) + + -- Replace chars with no texture by the NULL(0) char + if font.widths[char] == nil then + print(string.format("["..font_lib.name + .."] Missing char %d (%04x)",char,char)) + char = 0 end + + -- Add image only if it is visible (at least partly) + if x + font.widths[char] >= 0 and x <= width then + texture = texture.. + string.format(":%d,%d=font_%s_%04x.png", + x, y, font.name, char) + end + x = x + font.widths[char] end end - + return texture end @@ -172,43 +217,53 @@ end -- @param texturew Width of the texture (extra text will be truncated) -- @param textureh Height of the texture -- @param maxlines Maximum number of lines --- @param valign Vertical text align ("top" or "center") --- @param color Color of the text +-- @param halign Horizontal text align ("left"/"center"/"right") (optional) +-- @param valign Vertical text align ("top"/"center"/"bottom") (optional) +-- @param color Color of the text (optional) -- @return Texture string function font_lib.make_multiline_texture(font_name, text, width, height, - maxlines, valign, color) + maxlines, halign, valign, color) local texture = "" local lines = {} local textheight = 0 local y, w, h - + for num, line in pairs(split_lines(text, maxlines)) do w, h = font_lib.get_text_size(font_name, line) lines[num] = { text = line, width = w, height = h, } textheight = textheight + h end - + if #lines then if valign == "top" then y = 0 elseif valign == "bottom" then y = height - textheight - else + else y = (height - textheight) / 2 end end - + for _, line in pairs(lines) do - texture = texture.. - font_lib.make_line_texture(font_name, line.text, width, - (width - line.width) / 2, y) + if halign == "left" then + texture = texture.. + font_lib.make_line_texture(font_name, line.text, width, + 0, y) + elseif halign == "right" then + texture = texture.. + font_lib.make_line_texture(font_name, line.text, width, + width - line.width, y) + else + texture = texture.. + font_lib.make_line_texture(font_name, line.text, width, + (width - line.width) / 2, y) + end y = y + line.height end texture = string.format("[combine:%dx%d", width, height)..texture if color then texture = texture.."^[colorize:"..color end - return texture end @@ -217,40 +272,48 @@ end -- font_<name>_<code>.png -- <name> : name of the font -- <code> : 4 digit hexadecimal unicode of the char --- If registering different sizes, add size in the font name (e.g. times_10, times_12...) +-- @param font_name Name of the font to register +-- If registering different sizes of the same font, add size in the font name +-- (e.g. times_10, times_12...). -- @param height Font height in pixels --- @param widths Array of character widths in pixel, indexed by unicode number. +-- @param widths Array of character widths in pixels, indexed by UTF codepoints function font_lib.register_font(font_name, height, widths) + if font_lib.registered_fonts[font_name] ~= nil then minetest.log("error", "Font \""..font_name.."\" already registered.") return end - - font_lib.registered_fonts[font_name] = - { name = font_name, height = height, widths = widths } - - -- If no fallback font, set it (so, first font registered will be the default fallback font) - if font_lib.fallback_font == nil then - font_lib.fallback_font = font_name - end -end ---- Define the fallback font --- This font will be used instead of given font if not registered. --- @param font_name Name of the font to be used as fallback font (has to be registered). + if height == nil or height <= 0 then + minetest.log("error", "Font \""..font_name.. + "\" must have a positive height.") + return + end -function font_lib.set_fallback_font(font_name) - if font_lib.registered_fonts[font_name] == nil then - minetest.log("error", "Fallback font \""..font_name.."\" not registered.") - else - font_lib.fallback_font = font_name + if type(widths) ~= "table" then + minetest.log("error", "Font \""..font_name.. + "\" must have a widths array.") + return end + + if widths[0] == nil then + minetest.log("error", "Font \""..font_name.. + "\" must have a char with codepoint 0 (=unknown char).") + return + end + + font_lib.registered_fonts[font_name] = + { name = font_name, height = height, widths = widths } + + -- Force to choose again default font + -- (allows use of fonts registered after start) + default_font = false end --- Standard on_display_update entity callback. --- Node should have a corresponding display_entity with size, resolution and maxlines fields and --- optionally valign and color fields +-- Node should have a corresponding display_entity with size, resolution and +-- maxlines fields and optionally halign, valign and color fields -- @param pos Node position -- @param objref Object reference of entity @@ -262,15 +325,16 @@ function font_lib.on_display_update(pos, objref) if entity and ndef.display_entities[entity.name] then local def = ndef.display_entities[entity.name] + local font = get_font(def.font_name) objref:set_properties({ textures={font_lib.make_multiline_texture( - def.font_name, text, def.size.x*def.resolution.x, def.size.y*def.resolution.y, - def.maxlines, def.valign, def.color)}, + def.font_name, text, + def.size.x * def.resolution.x * font.height, + def.size.y * def.resolution.y * font.height, + def.maxlines, def.halign, def.valign, def.color)}, visual_size = def.size }) end end -dofile(font_lib.path.."/font_default.lua") - |