Leptonica  1.54
Файл src/textops.c
#include <string.h>
#include "allheaders.h"

Функции

static l_int32 stringAllWhitespace (char *textstr, l_int32 *pval)
static l_int32 stringLeadingWhitespace (char *textstr, l_int32 *pval)
PIXpixAddSingleTextblock (PIX *pixs, L_BMF *bmf, const char *textstr, l_uint32 val, l_int32 location, l_int32 *poverflow)
PIXpixAddTextlines (PIX *pixs, L_BMF *bmf, const char *textstr, l_uint32 val, l_int32 location)
l_int32 pixSetTextblock (PIX *pixs, L_BMF *bmf, const char *textstr, l_uint32 val, l_int32 x0, l_int32 y0, l_int32 wtext, l_int32 firstindent, l_int32 *poverflow)
l_int32 pixSetTextline (PIX *pixs, L_BMF *bmf, const char *textstr, l_uint32 val, l_int32 x0, l_int32 y0, l_int32 *pwidth, l_int32 *poverflow)
PIXApixaAddTextNumber (PIXA *pixas, L_BMF *bmf, NUMA *na, l_uint32 val, l_int32 location)
PIXApixaAddTextlines (PIXA *pixas, L_BMF *bmf, SARRAY *sa, l_uint32 val, l_int32 location)
l_int32 pixaAddPixWithText (PIXA *pixa, PIX *pixs, l_int32 reduction, L_BMF *bmf, const char *textstr, l_uint32 val, l_int32 location)
SARRAYbmfGetLineStrings (L_BMF *bmf, const char *textstr, l_int32 maxw, l_int32 firstindent, l_int32 *ph)
NUMAbmfGetWordWidths (L_BMF *bmf, const char *textstr, SARRAY *sa)
l_int32 bmfGetStringWidth (L_BMF *bmf, const char *textstr, l_int32 *pw)
SARRAYsplitStringToParagraphs (char *textstr, l_int32 splitflag)

Функции

SARRAY* bmfGetLineStrings ( L_BMF bmf,
const char *  textstr,
l_int32  maxw,
l_int32  firstindent,
l_int32 ph 
)

bmfGetLineStrings()

Input: bmf textstr maxw (max width of a text line in pixels) firstindent (indentation of first line, in x-widths) &h (<return> height required to hold text bitmap) Return: sarray of text strings for each line, or null on error

Notes: (1) Divides the input text string into an array of text strings, each of which will fit within maxw bits of width.

l_int32 bmfGetStringWidth ( L_BMF bmf,
const char *  textstr,
l_int32 pw 
)

bmfGetStringWidth()

Input: bmf textstr &w (<return> width of text string, in pixels for the font represented by the bmf) Return: 0 if OK, 1 on error

NUMA* bmfGetWordWidths ( L_BMF bmf,
const char *  textstr,
SARRAY sa 
)

bmfGetWordWidths()

Input: bmf textstr sa (of individual words) Return: numa (of word lengths in pixels for the font represented by the bmf), or null on error

l_int32 pixaAddPixWithText ( PIXA pixa,
PIX pixs,
l_int32  reduction,
L_BMF bmf,
const char *  textstr,
l_uint32  val,
l_int32  location 
)

pixaAddPixWithText()

Input: pixa pixs (any depth, colormap ok) reduction (integer subsampling factor) bmf (<optional> bitmap font data) textstr (<optional> text string to be added) val (color to set the text) location (L_ADD_ABOVE, L_ADD_BELOW, L_ADD_LEFT, L_ADD_RIGHT) Return: 0 if OK, 1 on error.

Notes: (1) This function generates a new pix with added text, and adds it by insertion into the pixa. (2) If the input pixs is not cmapped and not 32 bpp, it is converted to 32 bpp rgb. is a standard 32 bpp pixel, expressed as 0xrrggbb00. If there is a colormap, this does the best it can to use the requested color, or something close. (3) if == NULL, generate an 8 pt font; this takes about 5 msec. (4) If == NULL, use the text field in the pix. (5) In general, the text string can be written in multiple lines; use newlines as the separators. (6) Typical usage is for debugging, where the pixa of labelled images is used to generate a pdf. Suggest using 1.0 for scalefactor.

PIXA* pixaAddTextlines ( PIXA pixas,
L_BMF bmf,
SARRAY sa,
l_uint32  val,
l_int32  location 
)

pixaAddTextlines()

Input: pixas (input pixa; colormap ok) bmf (bitmap font data) sa (<optional> sarray; use text embedded in each pix if null) val (color to set the text) location (L_ADD_ABOVE, L_ADD_BELOW, L_ADD_LEFT, L_ADD_RIGHT) Return: pixad (new pixa with rendered text), or null on error

Notes: (1) This function adds one or more lines of text externally to each pix, in a position given by . In all cases, the pix is expanded as necessary to accommodate the text. (2) is the pixel value to be painted through the font mask. It should be chosen to agree with the depth of pixs. If it is out of bounds, an intermediate value is chosen. For RGB, use hex notation: 0xRRGGBB00, where RR is the hex representation of the red intensity, etc. (3) If sa == NULL, use the text embedded in each pix. In all cases, newlines in the text string are used to separate the lines of text that are added to the pix. (4) If sa has a smaller count than pixa, issue a warning and do not use any embedded text. (5) If there is a colormap, this does the best it can to use the requested color, or something similar to it.

PIXA* pixaAddTextNumber ( PIXA pixas,
L_BMF bmf,
NUMA na,
l_uint32  val,
l_int32  location 
)

pixaAddTextNumber()

Input: pixas (input pixa; colormap ok) bmf (bitmap font data) numa (<optional> number array; use 1 ... n if null) val (color to set the text) location (L_ADD_ABOVE, L_ADD_BELOW, L_ADD_LEFT, L_ADD_RIGHT) Return: pixad (new pixa with rendered numbers), or null on error

Notes: (1) Typical usage is for labelling each pix in a pixa with a number. (2) This function paints numbers external to each pix, in a position given by . In all cases, the pix is expanded on on side and the number is painted over white in the added region. (3) is the pixel value to be painted through the font mask. It should be chosen to agree with the depth of pixs. If it is out of bounds, an intermediate value is chosen. For RGB, use hex notation: 0xRRGGBB00, where RR is the hex representation of the red intensity, etc. (4) If na == NULL, number each pix sequentially, starting with 1. (5) If there is a colormap, this does the best it can to use the requested color, or something similar to it.

PIX* pixAddSingleTextblock ( PIX pixs,
L_BMF bmf,
const char *  textstr,
l_uint32  val,
l_int32  location,
l_int32 poverflow 
)

pixAddSingleTextblock()

Input: pixs (input pix; colormap ok) bmf (bitmap font data) textstr (<optional> text string to be added) val (color to set the text) location (L_ADD_ABOVE, L_ADD_AT_TOP, L_ADD_AT_BOT, L_ADD_BELOW) &overflow (<optional return>=""> 1 if text overflows allocated region and is clipped; 0 otherwise) Return: pixd (new pix with rendered text), or either a copy or null on error

Notes: (1) This function paints a set of lines of text over an image. If is L_ADD_ABOVE or L_ADD_BELOW, the pix size is expanded with a border and rendered over the border. (2) is the pixel value to be painted through the font mask. It should be chosen to agree with the depth of pixs. If it is out of bounds, an intermediate value is chosen. For RGB, use hex notation: 0xRRGGBB00, where RR is the hex representation of the red intensity, etc. (3) If textstr == NULL, use the text field in the pix. (4) If there is a colormap, this does the best it can to use the requested color, or something similar to it. (5) Typical usage is for labelling a pix with some text data.

PIX* pixAddTextlines ( PIX pixs,
L_BMF bmf,
const char *  textstr,
l_uint32  val,
l_int32  location 
)

pixAddTextlines()

Input: pixs (input pix; colormap ok) bmf (bitmap font data) textstr (<optional> text string to be added) val (color to set the text) location (L_ADD_ABOVE, L_ADD_BELOW, L_ADD_LEFT, L_ADD_RIGHT) Return: pixd (new pix with rendered text), or either a copy or null on error

Notes: (1) This function expands an image as required to paint one or more lines of text adjacent to the image. If == NULL, this returns a copy. If above or below, the lines are centered with respect to the image; if left or right, they are left justified. (2) is the pixel value to be painted through the font mask. It should be chosen to agree with the depth of pixs. If it is out of bounds, an intermediate value is chosen. For RGB, use hex notation: 0xRRGGBB00, where RR is the hex representation of the red intensity, etc. (3) If textstr == NULL, use the text field in the pix. The text field contains one or most "lines" of text, where newlines are used as line separators. (4) If there is a colormap, this does the best it can to use the requested color, or something similar to it. (5) Typical usage is for labelling a pix with some text data.

l_int32 pixSetTextblock ( PIX pixs,
L_BMF bmf,
const char *  textstr,
l_uint32  val,
l_int32  x0,
l_int32  y0,
l_int32  wtext,
l_int32  firstindent,
l_int32 poverflow 
)

pixSetTextblock()

Input: pixs (input image) bmf (bitmap font data) textstr (block text string to be set) val (color to set the text) x0 (left edge for each line of text) y0 (baseline location for the first text line) wtext (max width of each line of generated text) firstindent (indentation of first line, in x-widths) &overflow (<optional return>=""> 0 if text is contained in input pix; 1 if it is clipped) Return: 0 if OK, 1 on error

Notes: (1) This function paints a set of lines of text over an image. (2) is the pixel value to be painted through the font mask. It should be chosen to agree with the depth of pixs. If it is out of bounds, an intermediate value is chosen. For RGB, use hex notation: 0xRRGGBB00, where RR is the hex representation of the red intensity, etc. The last two hex digits are 00 (byte value 0), assigned to the A component. Note that, as usual, RGBA proceeds from left to right in the order from MSB to LSB (see pix.h for details). (3) If there is a colormap, this does the best it can to use the requested color, or something similar to it.

l_int32 pixSetTextline ( PIX pixs,
L_BMF bmf,
const char *  textstr,
l_uint32  val,
l_int32  x0,
l_int32  y0,
l_int32 pwidth,
l_int32 poverflow 
)

pixSetTextline()

Input: pixs (input image) bmf (bitmap font data) textstr (text string to be set on the line) val (color to set the text) x0 (left edge for first char) y0 (baseline location for all text on line) &width (<optional return>=""> width of generated text) &overflow (<optional return>=""> 0 if text is contained in input pix; 1 if it is clipped) Return: 0 if OK, 1 on error

Notes: (1) This function paints a line of text over an image. (2) is the pixel value to be painted through the font mask. It should be chosen to agree with the depth of pixs. If it is out of bounds, an intermediate value is chosen. For RGB, use hex notation: 0xRRGGBB00, where RR is the hex representation of the red intensity, etc. The last two hex digits are 00 (byte value 0), assigned to the A component. Note that, as usual, RGBA proceeds from left to right in the order from MSB to LSB (see pix.h for details). (3) If there is a colormap, this does the best it can to use the requested color, or something similar to it.

SARRAY* splitStringToParagraphs ( char *  textstr,
l_int32  splitflag 
)

splitStringToParagraphs()

Input: textstring splitting flag (see enum in bmf.h; valid values in {1,2,3}) Return: sarray (where each string is a paragraph of the input), or null on error.

static l_int32 stringAllWhitespace ( char *  textstr,
l_int32 pval 
) [static]

stringAllWhitespace()

Input: textstring &val (<return> 1 if all whitespace; 0 otherwise) Return: 0 if OK, 1 on error

static l_int32 stringLeadingWhitespace ( char *  textstr,
l_int32 pval 
) [static]

stringLeadingWhitespace()

Input: textstring &val (<return> 1 if leading char is ' ' or ''; 0 otherwise) Return: 0 if OK, 1 on error