font::ttf::xmlparse(3) [centos man page]
Font::TTF::XMLparse(3) User Contributed Perl Documentation Font::TTF::XMLparse(3) NAME
Font::TTF::XMLparse - provides support for XML parsing. Requires Expat module XML::Parser::Expat SYNOPSIS
use Font::TTF::Font; use Font::TTF::XMLparse; $f = Font::TTF::Font->new; read_xml($f, $ARGV[0]); $f->out($ARGV[1]); DESCRIPTION
This module contains the support routines for parsing XML and generating the Truetype font structures as a result. The module has been separated from the rest of the package in order to reduce the dependency that this would bring, of the whole package on XML::Parser. This way, people without the XML::Parser can still use the rest of the package. The package interacts with another package through the use of a context containing and element 'receiver' which is an object which can possibly receive one of the following messages: XML_start This message is called when an open tag occurs. It is called with the context, tag name and the attributes. The return value has no meaning. XML_end This messages is called when a close tag occurs. It is called with the context, tag name and attributes (held over from when the tag was opened). There are 3 possible return values from such a message: undef This is the default return value indicating that default processing should occur in which either the current element on the tree, or the text of this element should be stored in the parent object. $context This magic value marks that the element should be deleted from the parent. Nothing is stored in the parent. (This rather than '' is used to allow 0 returns.) anything Anything else is taken as the element content to be stored in the parent. In addition, the context hash passed to these messages contains the following keys: xml This is the expat xml object. The context is also available as $context->{'xml'}{' mycontext'}. But that is a long winded way of not saying much! font This is the base object that was passed in for XML parsing. receiver This holds the current receiver of parsing events. It may be set in associated application to adjust which objects should receive messages when. It is also stored in the parsing stack to ensure that where an object changes it during XML_start, that that same object that received XML_start will receive the corresponding XML_end stack This is the parsing stack, used internally to hold the current receiver and attributes for each element open, as a complete hierarchy back to the root element. tree This element contains the storage tree corresponding to the parent of each element in the stack. The default action is to push undef onto this stack during XML_start and then to resolve this, either in the associated application (by changing $context->{'tree'}[-1]) or during XML_end of a child element, by which time we know whether we are dealing with an array or a hash or what. text Character processing is to insert all the characters into the text element of the context for available use later. METHODS
POD ERRORS
Hey! The above document had some coding errors, which are explained below: Around line 58: =back doesn't take any parameters, but you said =back 4 Around line 60: =back doesn't take any parameters, but you said =back 4 Around line 101: =back doesn't take any parameters, but you said =back 4 perl v5.16.3 2011-10-13 Font::TTF::XMLparse(3)
Check Out this Related Man Page
Font::TTF::Table(3pm) User Contributed Perl Documentation Font::TTF::Table(3pm) NAME
Font::TTF::Table - Superclass for tables and used for tables we don't have a class for DESCRIPTION
Looks after the purely table aspects of a TTF table, such as whether the table has been read before, locating the file pointer, etc. Also copies tables from input to output. INSTANCE VARIABLES
Instance variables start with a space read Flag which indicates that the table has already been read from file. dat Allows the creation of unspecific tables. Data is simply output to any font file being created. INFILE The read file handle OFFSET Location of the file in the input file LENGTH Length in the input directory CSUM Checksum read from the input file's directory PARENT The Font::TTF::Font that table is part of METHODS
Font::TTF::Table->new(%parms) Creates a new table or subclass. Table instance variables are passed in at this point as an associative array. $t->read Reads the table from the input file. Acts as a superclass to all true tables. This method marks the table as read and then just sets the input file pointer but does not read any data. If the table has already been read, then returns "undef" else returns $self $t->read_dat Reads the table into the "dat" instance variable for those tables which don't know any better $t->out($fh) Writes out the table to the font file. If there is anything in the "data" instance variable then this is output, otherwise the data is copied from the input file to the output $t->out_xml($context) Outputs this table in XML format. The table is first read (if not already read) and then if there is no subclass, then the data is dumped as hex data $t->XML_element Output a particular element based on its contents. $t->XML_end($context, $tag, %attrs) Handles the default type of <data> for those tables which aren't subclassed $t->dirty($val) This sets the dirty flag to the given value or 1 if no given value. It returns the value of the flag $t->update Each table knows how to update itself. This consists of doing whatever work is required to ensure that the memory version of the table is consistent and that other parameters in other tables have been updated accordingly. I.e. by the end of sending "update" to all the tables, the memory version of the font should be entirely consistent. Some tables which do no work indicate to themselves the need to update themselves by setting isDirty above 1. This method resets that accordingly. $t->empty Clears a table of all data to the level of not having been read $t->release Releases ALL of the memory used by this table, and all of its component/child objects. This method is called automatically by 'Font::TTF::Font->release' (so you don't have to call it yourself). NOTE, that it is important that this method get called at some point prior to the actual destruction of the object. Internally, we track things in a structure that can result in circular references, and without calling '"release()"' these will not properly get cleaned up by Perl. Once this method has been called, though, don't expect to be able to do anything with the "Font::TTF::Table" object; it'll have no internal state whatsoever. Developer note: As part of the brute-force cleanup done here, this method will throw a warning message whenever unexpected key values are found within the "Font::TTF::Table" object. This is done to help ensure that any unexpected and unfreed values are brought to your attention so that you can bug us to keep the module updated properly; otherwise the potential for memory leaks due to dangling circular references will exist. BUGS
No known bugs AUTHOR
Martin Hosken Martin_Hosken@sil.org. See Font::TTF::Font for copyright and licensing. perl v5.10.1 2009-01-21 Font::TTF::Table(3pm)